dodopayments 2.31.2 → 2.32.0

package/src/resources/product-collections/groups/groups.ts

@@ -0,0 +1,156 @@
+// File generated from our OpenAPI spec by Stainless. See CONTRIBUTING.md for details.
+
+import { APIResource } from '../../../core/resource';
+import * as ItemsAPI from './items';
+import {
+  ItemCreateParams,
+  ItemCreateResponse,
+  ItemDeleteParams,
+  ItemUpdateParams,
+  Items,
+  ProductCollectionProduct,
+} from './items';
+import { APIPromise } from '../../../core/api-promise';
+import { buildHeaders } from '../../../internal/headers';
+import { RequestOptions } from '../../../internal/request-options';
+import { path } from '../../../internal/utils/path';
+
+export class Groups extends APIResource {
+  items: ItemsAPI.Items = new ItemsAPI.Items(this._client);
+
+  create(
+    id: string,
+    body: GroupCreateParams,
+    options?: RequestOptions,
+  ): APIPromise<ProductCollectionGroupResponse> {
+    return this._client.post(path`/product-collections/${id}/groups`, { body, ...options });
+  }
+
+  update(groupID: string, params: GroupUpdateParams, options?: RequestOptions): APIPromise<void> {
+    const { id, ...body } = params;
+    return this._client.patch(path`/product-collections/${id}/groups/${groupID}`, {
+      body,
+      ...options,
+      headers: buildHeaders([{ Accept: '*/*' }, options?.headers]),
+    });
+  }
+
+  delete(groupID: string, params: GroupDeleteParams, options?: RequestOptions): APIPromise<void> {
+    const { id } = params;
+    return this._client.delete(path`/product-collections/${id}/groups/${groupID}`, {
+      ...options,
+      headers: buildHeaders([{ Accept: '*/*' }, options?.headers]),
+    });
+  }
+}
+
+export interface GroupProduct {
+  /**
+   * Product ID to include in the group
+   */
+  product_id: string;
+
+  /**
+   * Status of the product in this group (defaults to true if not provided)
+   */
+  status?: boolean | null;
+}
+
+export interface ProductCollectionGroupDetails {
+  /**
+   * Products in this group
+   */
+  products: Array<GroupProduct>;
+
+  /**
+   * Optional group name. Multiple groups can have null names, but named groups must
+   * be unique per collection
+   */
+  group_name?: string | null;
+
+  /**
+   * Status of the group (defaults to true if not provided)
+   */
+  status?: boolean | null;
+}
+
+export interface ProductCollectionGroupResponse {
+  group_id: string;
+
+  products: Array<ItemsAPI.ProductCollectionProduct>;
+
+  status: boolean;
+
+  group_name?: string | null;
+}
+
+export interface GroupCreateParams {
+  /**
+   * Products in this group
+   */
+  products: Array<GroupProduct>;
+
+  /**
+   * Optional group name. Multiple groups can have null names, but named groups must
+   * be unique per collection
+   */
+  group_name?: string | null;
+
+  /**
+   * Status of the group (defaults to true if not provided)
+   */
+  status?: boolean | null;
+}
+
+export interface GroupUpdateParams {
+  /**
+   * Path param: Product Collection Id
+   */
+  id: string;
+
+  /**
+   * Body param: Optional group name update: Some(Some(name)) = set name, Some(None)
+   * = clear name, None = no change
+   */
+  group_name?: string | null;
+
+  /**
+   * Body param: Optional new order for products in this group (array of
+   * product_collection_group_pdts UUIDs)
+   */
+  product_order?: Array<string> | null;
+
+  /**
+   * Body param: Optional status update
+   */
+  status?: boolean | null;
+}
+
+export interface GroupDeleteParams {
+  /**
+   * Product Collection Id
+   */
+  id: string;
+}
+
+Groups.Items = Items;
+
+export declare namespace Groups {
+  export {
+    type GroupProduct as GroupProduct,
+    type ProductCollectionGroupDetails as ProductCollectionGroupDetails,
+    type ProductCollectionGroupResponse as ProductCollectionGroupResponse,
+    type GroupCreateParams as GroupCreateParams,
+    type GroupUpdateParams as GroupUpdateParams,
+    type GroupDeleteParams as GroupDeleteParams,
+  };
+
+  export {
+    Items as Items,
+    type ProductCollectionProduct as ProductCollectionProduct,
+    type ItemCreateResponse as ItemCreateResponse,
+    type ItemCreateParams as ItemCreateParams,
+    type ItemUpdateParams as ItemUpdateParams,
+    type ItemDeleteParams as ItemDeleteParams,
+  };
+}

package/src/resources/product-collections/groups/index.ts

@@ -0,0 +1,19 @@
+// File generated from our OpenAPI spec by Stainless. See CONTRIBUTING.md for details.
+
+export {
+  Groups,
+  type GroupProduct,
+  type ProductCollectionGroupDetails,
+  type ProductCollectionGroupResponse,
+  type GroupCreateParams,
+  type GroupUpdateParams,
+  type GroupDeleteParams,
+} from './groups';
+export {
+  Items,
+  type ProductCollectionProduct,
+  type ItemCreateResponse,
+  type ItemCreateParams,
+  type ItemUpdateParams,
+  type ItemDeleteParams,
+} from './items';

package/src/resources/product-collections/groups/items.ts

@@ -0,0 +1,135 @@
+// File generated from our OpenAPI spec by Stainless. See CONTRIBUTING.md for details.
+
+import { APIResource } from '../../../core/resource';
+import * as MiscAPI from '../../misc';
+import * as ProductsAPI from '../../products/products';
+import * as GroupsAPI from './groups';
+import { APIPromise } from '../../../core/api-promise';
+import { buildHeaders } from '../../../internal/headers';
+import { RequestOptions } from '../../../internal/request-options';
+import { path } from '../../../internal/utils/path';
+
+export class Items extends APIResource {
+  create(
+    groupID: string,
+    params: ItemCreateParams,
+    options?: RequestOptions,
+  ): APIPromise<ItemCreateResponse> {
+    const { id, ...body } = params;
+    return this._client.post(path`/product-collections/${id}/groups/${groupID}/items`, { body, ...options });
+  }
+
+  update(itemID: string, params: ItemUpdateParams, options?: RequestOptions): APIPromise<void> {
+    const { id, group_id, ...body } = params;
+    return this._client.patch(path`/product-collections/${id}/groups/${group_id}/items/${itemID}`, {
+      body,
+      ...options,
+      headers: buildHeaders([{ Accept: '*/*' }, options?.headers]),
+    });
+  }
+
+  delete(itemID: string, params: ItemDeleteParams, options?: RequestOptions): APIPromise<void> {
+    const { id, group_id } = params;
+    return this._client.delete(path`/product-collections/${id}/groups/${group_id}/items/${itemID}`, {
+      ...options,
+      headers: buildHeaders([{ Accept: '*/*' }, options?.headers]),
+    });
+  }
+}
+
+export interface ProductCollectionProduct {
+  id: string;
+
+  addons_count: number;
+
+  files_count: number;
+
+  /**
+   * Whether this product has any credit entitlements attached
+   */
+  has_credit_entitlements: boolean;
+
+  is_recurring: boolean;
+
+  license_key_enabled: boolean;
+
+  meters_count: number;
+
+  product_id: string;
+
+  status: boolean;
+
+  currency?: MiscAPI.Currency | null;
+
+  description?: string | null;
+
+  name?: string | null;
+
+  price?: number | null;
+
+  /**
+   * One-time price details.
+   */
+  price_detail?: ProductsAPI.Price | null;
+
+  /**
+   * Represents the different categories of taxation applicable to various products
+   * and services.
+   */
+  tax_category?: MiscAPI.TaxCategory | null;
+
+  tax_inclusive?: boolean | null;
+}
+
+export type ItemCreateResponse = Array<ProductCollectionProduct>;
+
+export interface ItemCreateParams {
+  /**
+   * Path param: Product Collection Id
+   */
+  id: string;
+
+  /**
+   * Body param: Products to add to the group
+   */
+  products: Array<GroupsAPI.GroupProduct>;
+}
+
+export interface ItemUpdateParams {
+  /**
+   * Path param: Product Collection Id
+   */
+  id: string;
+
+  /**
+   * Path param: Product Collection Group Id
+   */
+  group_id: string;
+
+  /**
+   * Body param: Status of the product in the group
+   */
+  status: boolean;
+}
+
+export interface ItemDeleteParams {
+  /**
+   * Product Collection Id
+   */
+  id: string;
+
+  /**
+   * Product Collection Group Id
+   */
+  group_id: string;
+}
+
+export declare namespace Items {
+  export {
+    type ProductCollectionProduct as ProductCollectionProduct,
+    type ItemCreateResponse as ItemCreateResponse,
+    type ItemCreateParams as ItemCreateParams,
+    type ItemUpdateParams as ItemUpdateParams,
+    type ItemDeleteParams as ItemDeleteParams,
+  };
+}

package/src/resources/product-collections/groups.ts

@@ -0,0 +1,3 @@
+// File generated from our OpenAPI spec by Stainless. See CONTRIBUTING.md for details.
+
+export * from './groups/index';

package/src/resources/product-collections/index.ts

@@ -0,0 +1,23 @@
+// File generated from our OpenAPI spec by Stainless. See CONTRIBUTING.md for details.
+
+export {
+  Groups,
+  type GroupProduct,
+  type ProductCollectionGroupDetails,
+  type ProductCollectionGroupResponse,
+  type GroupCreateParams,
+  type GroupUpdateParams,
+  type GroupDeleteParams,
+} from './groups/index';
+export {
+  ProductCollections,
+  type ProductCollection,
+  type ProductCollectionListResponse,
+  type ProductCollectionUnarchiveResponse,
+  type ProductCollectionUpdateImagesResponse,
+  type ProductCollectionCreateParams,
+  type ProductCollectionUpdateParams,
+  type ProductCollectionListParams,
+  type ProductCollectionUpdateImagesParams,
+  type ProductCollectionListResponsesDefaultPageNumberPagination,
+} from './product-collections';

package/src/resources/product-collections/product-collections.ts

@@ -0,0 +1,278 @@
+// File generated from our OpenAPI spec by Stainless. See CONTRIBUTING.md for details.
+
+import { APIResource } from '../../core/resource';
+import * as GroupsAPI from './groups/groups';
+import {
+  GroupCreateParams,
+  GroupDeleteParams,
+  GroupProduct,
+  GroupUpdateParams,
+  Groups,
+  ProductCollectionGroupDetails,
+  ProductCollectionGroupResponse,
+} from './groups/groups';
+import { APIPromise } from '../../core/api-promise';
+import {
+  DefaultPageNumberPagination,
+  type DefaultPageNumberPaginationParams,
+  PagePromise,
+} from '../../core/pagination';
+import { buildHeaders } from '../../internal/headers';
+import { RequestOptions } from '../../internal/request-options';
+import { path } from '../../internal/utils/path';
+
+export class ProductCollections extends APIResource {
+  groups: GroupsAPI.Groups = new GroupsAPI.Groups(this._client);
+
+  create(body: ProductCollectionCreateParams, options?: RequestOptions): APIPromise<ProductCollection> {
+    return this._client.post('/product-collections', { body, ...options });
+  }
+
+  retrieve(id: string, options?: RequestOptions): APIPromise<ProductCollection> {
+    return this._client.get(path`/product-collections/${id}`, options);
+  }
+
+  update(id: string, body: ProductCollectionUpdateParams, options?: RequestOptions): APIPromise<void> {
+    return this._client.patch(path`/product-collections/${id}`, {
+      body,
+      ...options,
+      headers: buildHeaders([{ Accept: '*/*' }, options?.headers]),
+    });
+  }
+
+  list(
+    query: ProductCollectionListParams | null | undefined = {},
+    options?: RequestOptions,
+  ): PagePromise<ProductCollectionListResponsesDefaultPageNumberPagination, ProductCollectionListResponse> {
+    return this._client.getAPIList(
+      '/product-collections',
+      DefaultPageNumberPagination<ProductCollectionListResponse>,
+      { query, ...options },
+    );
+  }
+
+  delete(id: string, options?: RequestOptions): APIPromise<void> {
+    return this._client.delete(path`/product-collections/${id}`, {
+      ...options,
+      headers: buildHeaders([{ Accept: '*/*' }, options?.headers]),
+    });
+  }
+
+  unarchive(id: string, options?: RequestOptions): APIPromise<ProductCollectionUnarchiveResponse> {
+    return this._client.post(path`/product-collections/${id}/unarchive`, options);
+  }
+
+  updateImages(
+    id: string,
+    params: ProductCollectionUpdateImagesParams | null | undefined = {},
+    options?: RequestOptions,
+  ): APIPromise<ProductCollectionUpdateImagesResponse> {
+    const { force_update } = params ?? {};
+    return this._client.put(path`/product-collections/${id}/images`, { query: { force_update }, ...options });
+  }
+}
+
+export type ProductCollectionListResponsesDefaultPageNumberPagination =
+  DefaultPageNumberPagination<ProductCollectionListResponse>;
+
+export interface ProductCollection {
+  /**
+   * Unique identifier for the product collection
+   */
+  id: string;
+
+  /**
+   * Brand ID for the collection
+   */
+  brand_id: string;
+
+  /**
+   * Timestamp when the collection was created
+   */
+  created_at: string;
+
+  /**
+   * Groups in this collection
+   */
+  groups: Array<GroupsAPI.ProductCollectionGroupResponse>;
+
+  /**
+   * Name of the collection
+   */
+  name: string;
+
+  /**
+   * Timestamp when the collection was last updated
+   */
+  updated_at: string;
+
+  /**
+   * Description of the collection
+   */
+  description?: string | null;
+
+  /**
+   * URL of the collection image
+   */
+  image?: string | null;
+}
+
+export interface ProductCollectionListResponse {
+  /**
+   * Collection ID
+   */
+  id: string;
+
+  /**
+   * Timestamp when created
+   */
+  created_at: string;
+
+  /**
+   * Collection name
+   */
+  name: string;
+
+  /**
+   * Number of products in the collection
+   */
+  products_count: number;
+
+  /**
+   * Timestamp when last updated
+   */
+  updated_at: string;
+
+  /**
+   * Collection description
+   */
+  description?: string | null;
+
+  /**
+   * Collection image URL
+   */
+  image?: string | null;
+}
+
+export interface ProductCollectionUnarchiveResponse {
+  /**
+   * Collection ID that was unarchived
+   */
+  collection_id: string;
+
+  /**
+   * Product IDs that were excluded because they are archived
+   */
+  excluded_product_ids: Array<string>;
+
+  /**
+   * Success message
+   */
+  message: string;
+}
+
+export interface ProductCollectionUpdateImagesResponse {
+  /**
+   * Presigned S3 URL for uploading the image
+   */
+  url: string;
+
+  /**
+   * Optional image ID (present when force_update is true)
+   */
+  image_id?: string | null;
+}
+
+export interface ProductCollectionCreateParams {
+  /**
+   * Groups of products in this collection
+   */
+  groups: Array<GroupsAPI.ProductCollectionGroupDetails>;
+
+  /**
+   * Name of the product collection
+   */
+  name: string;
+
+  /**
+   * Brand id for the collection, if not provided will default to primary brand
+   */
+  brand_id?: string | null;
+
+  /**
+   * Optional description of the product collection
+   */
+  description?: string | null;
+}
+
+export interface ProductCollectionUpdateParams {
+  /**
+   * Optional brand_id update
+   */
+  brand_id?: string | null;
+
+  /**
+   * Optional description update - pass null to remove, omit to keep unchanged
+   */
+  description?: string | null;
+
+  /**
+   * Optional new order for groups (array of group UUIDs in desired order)
+   */
+  group_order?: Array<string> | null;
+
+  /**
+   * Optional image update - pass null to remove, omit to keep unchanged
+   */
+  image_id?: string | null;
+
+  /**
+   * Optional new name for the collection
+   */
+  name?: string | null;
+}
+
+export interface ProductCollectionListParams extends DefaultPageNumberPaginationParams {
+  /**
+   * List archived collections
+   */
+  archived?: boolean;
+
+  /**
+   * Filter by Brand id
+   */
+  brand_id?: string;
+}
+
+export interface ProductCollectionUpdateImagesParams {
+  /**
+   * If true, generates a new image ID to force cache invalidation
+   */
+  force_update?: boolean | null;
+}
+
+ProductCollections.Groups = Groups;
+
+export declare namespace ProductCollections {
+  export {
+    type ProductCollection as ProductCollection,
+    type ProductCollectionListResponse as ProductCollectionListResponse,
+    type ProductCollectionUnarchiveResponse as ProductCollectionUnarchiveResponse,
+    type ProductCollectionUpdateImagesResponse as ProductCollectionUpdateImagesResponse,
+    type ProductCollectionListResponsesDefaultPageNumberPagination as ProductCollectionListResponsesDefaultPageNumberPagination,
+    type ProductCollectionCreateParams as ProductCollectionCreateParams,
+    type ProductCollectionUpdateParams as ProductCollectionUpdateParams,
+    type ProductCollectionListParams as ProductCollectionListParams,
+    type ProductCollectionUpdateImagesParams as ProductCollectionUpdateImagesParams,
+  };
+
+  export {
+    Groups as Groups,
+    type GroupProduct as GroupProduct,
+    type ProductCollectionGroupDetails as ProductCollectionGroupDetails,
+    type ProductCollectionGroupResponse as ProductCollectionGroupResponse,
+    type GroupCreateParams as GroupCreateParams,
+    type GroupUpdateParams as GroupUpdateParams,
+    type GroupDeleteParams as GroupDeleteParams,
+  };
+}

package/src/resources/product-collections.ts

@@ -0,0 +1,3 @@
+// File generated from our OpenAPI spec by Stainless. See CONTRIBUTING.md for details.
+
+export * from './product-collections/index';