@scaleway/sdk-billing 1.0.4 → 1.1.0

package/dist/v2beta1/api.gen.cjs

@@ -167,5 +167,25 @@ class API extends sdkClient.API {
      * @returns A Promise of ListDiscountsResponse
      */
   listDiscounts = (request = {}) => sdkClient.enrichForPagination("discounts", this.pageOfListDiscounts, request);
+  /**
+   * Redeem coupon. Redeem a coupon given the related code.
+   *
+   * @param request - The request {@link RedeemCouponRequest}
+   * @returns A Promise of Discount
+   */
+  redeemCoupon = (request) => this.client.fetch(
+    {
+      method: "POST",
+      path: `/billing/v2beta1/redeem-coupon`,
+      urlParams: sdkClient.urlParams(
+        ["code", request.code],
+        [
+          "organization_id",
+          request.organizationId ?? this.client.settings.defaultOrganizationId
+        ]
+      )
+    },
+    marshalling_gen.unmarshalDiscount
+  );
 }
 exports.API = API;

package/dist/v2beta1/api.gen.d.ts

@@ -1,5 +1,5 @@
 import { API as ParentAPI } from '@scaleway/sdk-client';
-import type { DownloadInvoiceRequest, ExportInvoicesRequest, GetInvoiceRequest, Invoice, ListConsumptionsRequest, ListConsumptionsResponse, ListDiscountsRequest, ListDiscountsResponse, ListInvoicesRequest, ListInvoicesResponse, ListTaxesRequest, ListTaxesResponse } from './types.gen';
+import type { Discount, DownloadInvoiceRequest, ExportInvoicesRequest, GetInvoiceRequest, Invoice, ListConsumptionsRequest, ListConsumptionsResponse, ListDiscountsRequest, ListDiscountsResponse, ListInvoicesRequest, ListInvoicesResponse, ListTaxesRequest, ListTaxesResponse, RedeemCouponRequest } from './types.gen';
 /**
  * Billing API.
 
@@ -71,7 +71,14 @@ export declare class API extends ParentAPI {
      * @returns A Promise of ListDiscountsResponse
      */
     listDiscounts: (request?: Readonly<ListDiscountsRequest>) => Promise<ListDiscountsResponse> & {
-        all: () => Promise<import("./types.gen").Discount[]>;
-        [Symbol.asyncIterator]: () => AsyncGenerator<import("./types.gen").Discount[], void, void>;
+        all: () => Promise<Discount[]>;
+        [Symbol.asyncIterator]: () => AsyncGenerator<Discount[], void, void>;
     };
+    /**
+     * Redeem coupon. Redeem a coupon given the related code.
+     *
+     * @param request - The request {@link RedeemCouponRequest}
+     * @returns A Promise of Discount
+     */
+    redeemCoupon: (request: Readonly<RedeemCouponRequest>) => Promise<Discount>;
 }

package/dist/v2beta1/api.gen.js

@@ -1,5 +1,5 @@
 import { API as API$1, urlParams, resolveOneOf, enrichForPagination, validatePathParam } from "@scaleway/sdk-client";
-import { unmarshalListConsumptionsResponse, unmarshalListTaxesResponse, unmarshalListInvoicesResponse, unmarshalInvoice, unmarshalListDiscountsResponse } from "./marshalling.gen.js";
+import { unmarshalListConsumptionsResponse, unmarshalListTaxesResponse, unmarshalListInvoicesResponse, unmarshalInvoice, unmarshalListDiscountsResponse, unmarshalDiscount } from "./marshalling.gen.js";
 class API extends API$1 {
   pageOfListConsumptions = (request = {}) => this.client.fetch(
     {
@@ -165,6 +165,26 @@ class API extends API$1 {
      * @returns A Promise of ListDiscountsResponse
      */
   listDiscounts = (request = {}) => enrichForPagination("discounts", this.pageOfListDiscounts, request);
+  /**
+   * Redeem coupon. Redeem a coupon given the related code.
+   *
+   * @param request - The request {@link RedeemCouponRequest}
+   * @returns A Promise of Discount
+   */
+  redeemCoupon = (request) => this.client.fetch(
+    {
+      method: "POST",
+      path: `/billing/v2beta1/redeem-coupon`,
+      urlParams: urlParams(
+        ["code", request.code],
+        [
+          "organization_id",
+          request.organizationId ?? this.client.settings.defaultOrganizationId
+        ]
+      )
+    },
+    unmarshalDiscount
+  );
 }
 export {
   API

package/dist/v2beta1/index.gen.cjs

@@ -3,6 +3,7 @@ Object.defineProperty(exports, Symbol.toStringTag, { value: "Module" });
 const api_gen = require("./api.gen.cjs");
 const marshalling_gen = require("./marshalling.gen.cjs");
 exports.API = api_gen.API;
+exports.unmarshalDiscount = marshalling_gen.unmarshalDiscount;
 exports.unmarshalInvoice = marshalling_gen.unmarshalInvoice;
 exports.unmarshalListConsumptionsResponse = marshalling_gen.unmarshalListConsumptionsResponse;
 exports.unmarshalListDiscountsResponse = marshalling_gen.unmarshalListDiscountsResponse;

package/dist/v2beta1/index.gen.d.ts

@@ -1,3 +1,3 @@
 export { API } from './api.gen';
 export * from './marshalling.gen';
-export type { Discount, DiscountCoupon, DiscountDiscountMode, DiscountFilter, DiscountFilterType, DownloadInvoiceRequest, DownloadInvoiceRequestFileType, ExportInvoicesRequest, ExportInvoicesRequestFileType, ExportInvoicesRequestOrderBy, GetInvoiceRequest, Invoice, InvoiceType, ListConsumptionsRequest, ListConsumptionsRequestOrderBy, ListConsumptionsResponse, ListConsumptionsResponseConsumption, ListDiscountsRequest, ListDiscountsRequestOrderBy, ListDiscountsResponse, ListInvoicesRequest, ListInvoicesRequestOrderBy, ListInvoicesResponse, ListTaxesRequest, ListTaxesRequestOrderBy, ListTaxesResponse, ListTaxesResponseTax, } from './types.gen';
+export type { Discount, DiscountCoupon, DiscountDiscountMode, DiscountFilter, DiscountFilterType, DownloadInvoiceRequest, DownloadInvoiceRequestFileType, ExportInvoicesRequest, ExportInvoicesRequestFileType, ExportInvoicesRequestOrderBy, GetInvoiceRequest, Invoice, InvoiceType, ListConsumptionsRequest, ListConsumptionsRequestOrderBy, ListConsumptionsResponse, ListConsumptionsResponseConsumption, ListDiscountsRequest, ListDiscountsRequestOrderBy, ListDiscountsResponse, ListInvoicesRequest, ListInvoicesRequestOrderBy, ListInvoicesResponse, ListTaxesRequest, ListTaxesRequestOrderBy, ListTaxesResponse, ListTaxesResponseTax, RedeemCouponRequest, } from './types.gen';

package/dist/v2beta1/index.gen.js

@@ -1,7 +1,8 @@
 import { API } from "./api.gen.js";
-import { unmarshalInvoice, unmarshalListConsumptionsResponse, unmarshalListDiscountsResponse, unmarshalListInvoicesResponse, unmarshalListTaxesResponse } from "./marshalling.gen.js";
+import { unmarshalDiscount, unmarshalInvoice, unmarshalListConsumptionsResponse, unmarshalListDiscountsResponse, unmarshalListInvoicesResponse, unmarshalListTaxesResponse } from "./marshalling.gen.js";
 export {
   API,
+  unmarshalDiscount,
   unmarshalInvoice,
   unmarshalListConsumptionsResponse,
   unmarshalListDiscountsResponse,

package/dist/v2beta1/marshalling.gen.cjs

@@ -1,6 +1,49 @@
 "use strict";
 Object.defineProperty(exports, Symbol.toStringTag, { value: "Module" });
 const sdkClient = require("@scaleway/sdk-client");
+const unmarshalDiscountCoupon = (data) => {
+  if (!sdkClient.isJSONObject(data)) {
+    throw new TypeError(
+      `Unmarshalling the type 'DiscountCoupon' failed as data isn't a dictionary.`
+    );
+  }
+  return {
+    description: data.description
+  };
+};
+const unmarshalDiscountFilter = (data) => {
+  if (!sdkClient.isJSONObject(data)) {
+    throw new TypeError(
+      `Unmarshalling the type 'DiscountFilter' failed as data isn't a dictionary.`
+    );
+  }
+  return {
+    exclude: data.exclude,
+    type: data.type,
+    value: data.value
+  };
+};
+const unmarshalDiscount = (data) => {
+  if (!sdkClient.isJSONObject(data)) {
+    throw new TypeError(
+      `Unmarshalling the type 'Discount' failed as data isn't a dictionary.`
+    );
+  }
+  return {
+    coupon: data.coupon ? unmarshalDiscountCoupon(data.coupon) : void 0,
+    creationDate: sdkClient.unmarshalDate(data.creation_date),
+    description: data.description,
+    filters: sdkClient.unmarshalArrayOfObject(data.filters, unmarshalDiscountFilter),
+    id: data.id,
+    mode: data.mode,
+    organizationId: data.organization_id,
+    startDate: sdkClient.unmarshalDate(data.start_date),
+    stopDate: sdkClient.unmarshalDate(data.stop_date),
+    value: data.value,
+    valueRemaining: data.value_remaining,
+    valueUsed: data.value_used
+  };
+};
 const unmarshalInvoice = (data) => {
   if (!sdkClient.isJSONObject(data)) {
     throw new TypeError(
@@ -60,49 +103,6 @@ const unmarshalListConsumptionsResponse = (data) => {
     updatedAt: sdkClient.unmarshalDate(data.updated_at)
   };
 };
-const unmarshalDiscountCoupon = (data) => {
-  if (!sdkClient.isJSONObject(data)) {
-    throw new TypeError(
-      `Unmarshalling the type 'DiscountCoupon' failed as data isn't a dictionary.`
-    );
-  }
-  return {
-    description: data.description
-  };
-};
-const unmarshalDiscountFilter = (data) => {
-  if (!sdkClient.isJSONObject(data)) {
-    throw new TypeError(
-      `Unmarshalling the type 'DiscountFilter' failed as data isn't a dictionary.`
-    );
-  }
-  return {
-    exclude: data.exclude,
-    type: data.type,
-    value: data.value
-  };
-};
-const unmarshalDiscount = (data) => {
-  if (!sdkClient.isJSONObject(data)) {
-    throw new TypeError(
-      `Unmarshalling the type 'Discount' failed as data isn't a dictionary.`
-    );
-  }
-  return {
-    coupon: data.coupon ? unmarshalDiscountCoupon(data.coupon) : void 0,
-    creationDate: sdkClient.unmarshalDate(data.creation_date),
-    description: data.description,
-    filters: sdkClient.unmarshalArrayOfObject(data.filters, unmarshalDiscountFilter),
-    id: data.id,
-    mode: data.mode,
-    organizationId: data.organization_id,
-    startDate: sdkClient.unmarshalDate(data.start_date),
-    stopDate: sdkClient.unmarshalDate(data.stop_date),
-    value: data.value,
-    valueRemaining: data.value_remaining,
-    valueUsed: data.value_used
-  };
-};
 const unmarshalListDiscountsResponse = (data) => {
   if (!sdkClient.isJSONObject(data)) {
     throw new TypeError(
@@ -150,6 +150,7 @@ const unmarshalListTaxesResponse = (data) => {
     updatedAt: sdkClient.unmarshalDate(data.updated_at)
   };
 };
+exports.unmarshalDiscount = unmarshalDiscount;
 exports.unmarshalInvoice = unmarshalInvoice;
 exports.unmarshalListConsumptionsResponse = unmarshalListConsumptionsResponse;
 exports.unmarshalListDiscountsResponse = unmarshalListDiscountsResponse;

package/dist/v2beta1/marshalling.gen.d.ts

@@ -1,4 +1,5 @@
-import type { Invoice, ListConsumptionsResponse, ListDiscountsResponse, ListInvoicesResponse, ListTaxesResponse } from './types.gen';
+import type { Discount, Invoice, ListConsumptionsResponse, ListDiscountsResponse, ListInvoicesResponse, ListTaxesResponse } from './types.gen';
+export declare const unmarshalDiscount: (data: unknown) => Discount;
 export declare const unmarshalInvoice: (data: unknown) => Invoice;
 export declare const unmarshalListConsumptionsResponse: (data: unknown) => ListConsumptionsResponse;
 export declare const unmarshalListDiscountsResponse: (data: unknown) => ListDiscountsResponse;

package/dist/v2beta1/marshalling.gen.js

@@ -1,4 +1,47 @@
-import { isJSONObject, unmarshalMoney, unmarshalDate, unmarshalArrayOfObject } from "@scaleway/sdk-client";
+import { isJSONObject, unmarshalDate, unmarshalArrayOfObject, unmarshalMoney } from "@scaleway/sdk-client";
+const unmarshalDiscountCoupon = (data) => {
+  if (!isJSONObject(data)) {
+    throw new TypeError(
+      `Unmarshalling the type 'DiscountCoupon' failed as data isn't a dictionary.`
+    );
+  }
+  return {
+    description: data.description
+  };
+};
+const unmarshalDiscountFilter = (data) => {
+  if (!isJSONObject(data)) {
+    throw new TypeError(
+      `Unmarshalling the type 'DiscountFilter' failed as data isn't a dictionary.`
+    );
+  }
+  return {
+    exclude: data.exclude,
+    type: data.type,
+    value: data.value
+  };
+};
+const unmarshalDiscount = (data) => {
+  if (!isJSONObject(data)) {
+    throw new TypeError(
+      `Unmarshalling the type 'Discount' failed as data isn't a dictionary.`
+    );
+  }
+  return {
+    coupon: data.coupon ? unmarshalDiscountCoupon(data.coupon) : void 0,
+    creationDate: unmarshalDate(data.creation_date),
+    description: data.description,
+    filters: unmarshalArrayOfObject(data.filters, unmarshalDiscountFilter),
+    id: data.id,
+    mode: data.mode,
+    organizationId: data.organization_id,
+    startDate: unmarshalDate(data.start_date),
+    stopDate: unmarshalDate(data.stop_date),
+    value: data.value,
+    valueRemaining: data.value_remaining,
+    valueUsed: data.value_used
+  };
+};
 const unmarshalInvoice = (data) => {
   if (!isJSONObject(data)) {
     throw new TypeError(
@@ -58,49 +101,6 @@ const unmarshalListConsumptionsResponse = (data) => {
     updatedAt: unmarshalDate(data.updated_at)
   };
 };
-const unmarshalDiscountCoupon = (data) => {
-  if (!isJSONObject(data)) {
-    throw new TypeError(
-      `Unmarshalling the type 'DiscountCoupon' failed as data isn't a dictionary.`
-    );
-  }
-  return {
-    description: data.description
-  };
-};
-const unmarshalDiscountFilter = (data) => {
-  if (!isJSONObject(data)) {
-    throw new TypeError(
-      `Unmarshalling the type 'DiscountFilter' failed as data isn't a dictionary.`
-    );
-  }
-  return {
-    exclude: data.exclude,
-    type: data.type,
-    value: data.value
-  };
-};
-const unmarshalDiscount = (data) => {
-  if (!isJSONObject(data)) {
-    throw new TypeError(
-      `Unmarshalling the type 'Discount' failed as data isn't a dictionary.`
-    );
-  }
-  return {
-    coupon: data.coupon ? unmarshalDiscountCoupon(data.coupon) : void 0,
-    creationDate: unmarshalDate(data.creation_date),
-    description: data.description,
-    filters: unmarshalArrayOfObject(data.filters, unmarshalDiscountFilter),
-    id: data.id,
-    mode: data.mode,
-    organizationId: data.organization_id,
-    startDate: unmarshalDate(data.start_date),
-    stopDate: unmarshalDate(data.stop_date),
-    value: data.value,
-    valueRemaining: data.value_remaining,
-    valueUsed: data.value_used
-  };
-};
 const unmarshalListDiscountsResponse = (data) => {
   if (!isJSONObject(data)) {
     throw new TypeError(
@@ -149,6 +149,7 @@ const unmarshalListTaxesResponse = (data) => {
   };
 };
 export {
+  unmarshalDiscount,
   unmarshalInvoice,
   unmarshalListConsumptionsResponse,
   unmarshalListDiscountsResponse,

package/dist/v2beta1/types.gen.d.ts

@@ -398,3 +398,13 @@ export interface ListTaxesResponse {
      */
     updatedAt?: Date;
 }
+export type RedeemCouponRequest = {
+    /**
+     * The Organization ID of the discount.
+     */
+    organizationId?: string;
+    /**
+     * The code of the coupon to redeem.
+     */
+    code: string;
+};

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@scaleway/sdk-billing",
-  "version": "1.0.4",
+  "version": "1.1.0",
   "description": "Scaleway SDK billing",
   "license": "Apache-2.0",
   "files": [
@@ -30,13 +30,13 @@
   },
   "dependencies": {
     "@scaleway/random-name": "5.1.1",
-    "@scaleway/sdk-std": "1.0.4"
+    "@scaleway/sdk-std": "1.0.5"
   },
   "peerDependencies": {
-    "@scaleway/sdk-client": "^1.2.3"
+    "@scaleway/sdk-client": "^1.3.0"
   },
   "devDependencies": {
-    "@scaleway/sdk-client": "^1.2.3"
+    "@scaleway/sdk-client": "^1.3.0"
   },
   "scripts": {
     "package:check": "pnpm publint",