mollie-api-typescript 0.9.5 → 0.9.6

package/src/models/listprofileresponse.ts

@@ -0,0 +1,365 @@
+/*
+ * Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT.
+ */
+
+import * as z from "zod/v3";
+import { remap as remap$ } from "../lib/primitives.js";
+import { safeParse } from "../lib/schemas.js";
+import * as openEnums from "../types/enums.js";
+import { OpenEnum } from "../types/enums.js";
+import { Result as SafeParseResult } from "../types/fp.js";
+import { SDKValidationError } from "./errors/sdkvalidationerror.js";
+import { Mode, Mode$inboundSchema, Mode$outboundSchema } from "./mode.js";
+import {
+  ProfileReviewStatusResponse,
+  ProfileReviewStatusResponse$inboundSchema,
+  ProfileReviewStatusResponse$outboundSchema,
+} from "./profilereviewstatusresponse.js";
+import {
+  Url,
+  Url$inboundSchema,
+  Url$Outbound,
+  Url$outboundSchema,
+} from "./url.js";
+
+/**
+ * The profile status determines whether the profile is able to receive live payments.
+ *
+ * @remarks
+ *
+ * * `unverified`: The profile has not been verified yet and can only be used to create test payments.
+ * * `verified`: The profile has been verified and can be used to create live payments and test payments.
+ * * `blocked`: The profile is blocked and can no longer be used or changed.
+ */
+export const ListProfileResponseStatus = {
+  Unverified: "unverified",
+  Verified: "verified",
+  Blocked: "blocked",
+} as const;
+/**
+ * The profile status determines whether the profile is able to receive live payments.
+ *
+ * @remarks
+ *
+ * * `unverified`: The profile has not been verified yet and can only be used to create test payments.
+ * * `verified`: The profile has been verified and can be used to create live payments and test payments.
+ * * `blocked`: The profile is blocked and can no longer be used or changed.
+ */
+export type ListProfileResponseStatus = OpenEnum<
+  typeof ListProfileResponseStatus
+>;
+
+/**
+ * Present if changes have been made that have not yet been approved by Mollie. Changes to test profiles are approved
+ *
+ * @remarks
+ * automatically, unless a switch to a live profile has been requested. The review object will therefore usually be
+ * `null` in test mode.
+ */
+export type ListProfileResponseReview = {
+  /**
+   * The status of the requested changes.
+   */
+  status?: ProfileReviewStatusResponse | undefined;
+};
+
+/**
+ * An object with several relevant URLs. Every URL object will contain an `href` and a `type` field.
+ */
+export type ListProfileResponseLinks = {
+  /**
+   * In v2 endpoints, URLs are commonly represented as objects with an `href` and `type` field.
+   */
+  self?: Url | undefined;
+  /**
+   * In v2 endpoints, URLs are commonly represented as objects with an `href` and `type` field.
+   */
+  dashboard?: Url | undefined;
+  /**
+   * In v2 endpoints, URLs are commonly represented as objects with an `href` and `type` field.
+   */
+  chargebacks?: Url | undefined;
+  /**
+   * In v2 endpoints, URLs are commonly represented as objects with an `href` and `type` field.
+   */
+  methods?: Url | undefined;
+  /**
+   * In v2 endpoints, URLs are commonly represented as objects with an `href` and `type` field.
+   */
+  payments?: Url | undefined;
+  /**
+   * In v2 endpoints, URLs are commonly represented as objects with an `href` and `type` field.
+   */
+  refunds?: Url | undefined;
+  /**
+   * In v2 endpoints, URLs are commonly represented as objects with an `href` and `type` field.
+   */
+  checkoutPreviewUrl?: Url | undefined;
+};
+
+export type ListProfileResponse = {
+  /**
+   * Indicates the response contains a profile object. Will always contain the string `profile` for this endpoint.
+   */
+  resource: string;
+  /**
+   * The identifier uniquely referring to this profile. Example: `pfl_v9hTwCvYqw`.
+   */
+  id: string;
+  /**
+   * Whether this entity was created in live mode or in test mode.
+   */
+  mode: Mode;
+  /**
+   * The profile's name, this will usually reflect the trade name or brand name of the profile's website or
+   *
+   * @remarks
+   * application.
+   */
+  name: string;
+  /**
+   * The URL to the profile's website or application. Only `https` or `http` URLs are allowed. No `@` signs are
+   *
+   * @remarks
+   * allowed.
+   */
+  website: string;
+  /**
+   * The email address associated with the profile's trade name or brand.
+   */
+  email: string;
+  /**
+   * The phone number associated with the profile's trade name or brand.
+   */
+  phone: string;
+  /**
+   * The products or services offered by the profile's website or application.
+   */
+  description?: string | undefined;
+  /**
+   * A list of countries where you expect that the majority of the profile's customers reside,
+   *
+   * @remarks
+   * in [ISO 3166-1 alpha-2](https://en.wikipedia.org/wiki/ISO_3166-1_alpha-2) format.
+   */
+  countriesOfActivity?: Array<string> | undefined;
+  /**
+   * The industry associated with the profile's trade name or brand. Please refer to the
+   *
+   * @remarks
+   * [business category list](common-data-types#business-category) for all possible options.
+   */
+  businessCategory: string;
+  status: ListProfileResponseStatus;
+  /**
+   * Present if changes have been made that have not yet been approved by Mollie. Changes to test profiles are approved
+   *
+   * @remarks
+   * automatically, unless a switch to a live profile has been requested. The review object will therefore usually be
+   * `null` in test mode.
+   */
+  review?: ListProfileResponseReview | undefined;
+  /**
+   * The entity's date and time of creation, in [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) format.
+   */
+  createdAt: string;
+  /**
+   * An object with several relevant URLs. Every URL object will contain an `href` and a `type` field.
+   */
+  links: ListProfileResponseLinks;
+};
+
+/** @internal */
+export const ListProfileResponseStatus$inboundSchema: z.ZodType<
+  ListProfileResponseStatus,
+  z.ZodTypeDef,
+  unknown
+> = openEnums.inboundSchema(ListProfileResponseStatus);
+/** @internal */
+export const ListProfileResponseStatus$outboundSchema: z.ZodType<
+  string,
+  z.ZodTypeDef,
+  ListProfileResponseStatus
+> = openEnums.outboundSchema(ListProfileResponseStatus);
+
+/** @internal */
+export const ListProfileResponseReview$inboundSchema: z.ZodType<
+  ListProfileResponseReview,
+  z.ZodTypeDef,
+  unknown
+> = z.object({
+  status: ProfileReviewStatusResponse$inboundSchema.optional(),
+});
+/** @internal */
+export type ListProfileResponseReview$Outbound = {
+  status?: string | undefined;
+};
+
+/** @internal */
+export const ListProfileResponseReview$outboundSchema: z.ZodType<
+  ListProfileResponseReview$Outbound,
+  z.ZodTypeDef,
+  ListProfileResponseReview
+> = z.object({
+  status: ProfileReviewStatusResponse$outboundSchema.optional(),
+});
+
+export function listProfileResponseReviewToJSON(
+  listProfileResponseReview: ListProfileResponseReview,
+): string {
+  return JSON.stringify(
+    ListProfileResponseReview$outboundSchema.parse(listProfileResponseReview),
+  );
+}
+export function listProfileResponseReviewFromJSON(
+  jsonString: string,
+): SafeParseResult<ListProfileResponseReview, SDKValidationError> {
+  return safeParse(
+    jsonString,
+    (x) => ListProfileResponseReview$inboundSchema.parse(JSON.parse(x)),
+    `Failed to parse 'ListProfileResponseReview' from JSON`,
+  );
+}
+
+/** @internal */
+export const ListProfileResponseLinks$inboundSchema: z.ZodType<
+  ListProfileResponseLinks,
+  z.ZodTypeDef,
+  unknown
+> = z.object({
+  self: Url$inboundSchema.optional(),
+  dashboard: Url$inboundSchema.optional(),
+  chargebacks: Url$inboundSchema.optional(),
+  methods: Url$inboundSchema.optional(),
+  payments: Url$inboundSchema.optional(),
+  refunds: Url$inboundSchema.optional(),
+  checkoutPreviewUrl: Url$inboundSchema.optional(),
+});
+/** @internal */
+export type ListProfileResponseLinks$Outbound = {
+  self?: Url$Outbound | undefined;
+  dashboard?: Url$Outbound | undefined;
+  chargebacks?: Url$Outbound | undefined;
+  methods?: Url$Outbound | undefined;
+  payments?: Url$Outbound | undefined;
+  refunds?: Url$Outbound | undefined;
+  checkoutPreviewUrl?: Url$Outbound | undefined;
+};
+
+/** @internal */
+export const ListProfileResponseLinks$outboundSchema: z.ZodType<
+  ListProfileResponseLinks$Outbound,
+  z.ZodTypeDef,
+  ListProfileResponseLinks
+> = z.object({
+  self: Url$outboundSchema.optional(),
+  dashboard: Url$outboundSchema.optional(),
+  chargebacks: Url$outboundSchema.optional(),
+  methods: Url$outboundSchema.optional(),
+  payments: Url$outboundSchema.optional(),
+  refunds: Url$outboundSchema.optional(),
+  checkoutPreviewUrl: Url$outboundSchema.optional(),
+});
+
+export function listProfileResponseLinksToJSON(
+  listProfileResponseLinks: ListProfileResponseLinks,
+): string {
+  return JSON.stringify(
+    ListProfileResponseLinks$outboundSchema.parse(listProfileResponseLinks),
+  );
+}
+export function listProfileResponseLinksFromJSON(
+  jsonString: string,
+): SafeParseResult<ListProfileResponseLinks, SDKValidationError> {
+  return safeParse(
+    jsonString,
+    (x) => ListProfileResponseLinks$inboundSchema.parse(JSON.parse(x)),
+    `Failed to parse 'ListProfileResponseLinks' from JSON`,
+  );
+}
+
+/** @internal */
+export const ListProfileResponse$inboundSchema: z.ZodType<
+  ListProfileResponse,
+  z.ZodTypeDef,
+  unknown
+> = z.object({
+  resource: z.string(),
+  id: z.string(),
+  mode: Mode$inboundSchema,
+  name: z.string(),
+  website: z.string(),
+  email: z.string(),
+  phone: z.string(),
+  description: z.string().optional(),
+  countriesOfActivity: z.array(z.string()).optional(),
+  businessCategory: z.string(),
+  status: ListProfileResponseStatus$inboundSchema,
+  review: z.lazy(() => ListProfileResponseReview$inboundSchema).optional(),
+  createdAt: z.string(),
+  _links: z.lazy(() => ListProfileResponseLinks$inboundSchema),
+}).transform((v) => {
+  return remap$(v, {
+    "_links": "links",
+  });
+});
+/** @internal */
+export type ListProfileResponse$Outbound = {
+  resource: string;
+  id: string;
+  mode: string;
+  name: string;
+  website: string;
+  email: string;
+  phone: string;
+  description?: string | undefined;
+  countriesOfActivity?: Array<string> | undefined;
+  businessCategory: string;
+  status: string;
+  review?: ListProfileResponseReview$Outbound | undefined;
+  createdAt: string;
+  _links: ListProfileResponseLinks$Outbound;
+};
+
+/** @internal */
+export const ListProfileResponse$outboundSchema: z.ZodType<
+  ListProfileResponse$Outbound,
+  z.ZodTypeDef,
+  ListProfileResponse
+> = z.object({
+  resource: z.string(),
+  id: z.string(),
+  mode: Mode$outboundSchema,
+  name: z.string(),
+  website: z.string(),
+  email: z.string(),
+  phone: z.string(),
+  description: z.string().optional(),
+  countriesOfActivity: z.array(z.string()).optional(),
+  businessCategory: z.string(),
+  status: ListProfileResponseStatus$outboundSchema,
+  review: z.lazy(() => ListProfileResponseReview$outboundSchema).optional(),
+  createdAt: z.string(),
+  links: z.lazy(() => ListProfileResponseLinks$outboundSchema),
+}).transform((v) => {
+  return remap$(v, {
+    links: "_links",
+  });
+});
+
+export function listProfileResponseToJSON(
+  listProfileResponse: ListProfileResponse,
+): string {
+  return JSON.stringify(
+    ListProfileResponse$outboundSchema.parse(listProfileResponse),
+  );
+}
+export function listProfileResponseFromJSON(
+  jsonString: string,
+): SafeParseResult<ListProfileResponse, SDKValidationError> {
+  return safeParse(
+    jsonString,
+    (x) => ListProfileResponse$inboundSchema.parse(JSON.parse(x)),
+    `Failed to parse 'ListProfileResponse' from JSON`,
+  );
+}

package/src/models/{routegetresponse.ts → listroutegetresponse.ts}

@@ -28,7 +28,7 @@ import {
 /**
  * The destination of the route.
  */
-export type RouteGetResponseDestination = {
+export type ListRouteGetResponseDestination = {
   /**
    * The type of destination. Currently only the destination type `organization` is supported.
    */
@@ -39,18 +39,14 @@ export type RouteGetResponseDestination = {
 /**
  * An object with several relevant URLs. Every URL object will contain an `href` and a `type` field.
  */
-export type RouteGetResponseLinks = {
+export type ListRouteGetResponseLinks = {
   /**
    * In v2 endpoints, URLs are commonly represented as objects with an `href` and `type` field.
    */
   self: Url;
-  /**
-   * In v2 endpoints, URLs are commonly represented as objects with an `href` and `type` field.
-   */
-  documentation: Url;
 };
 
-export type RouteGetResponse = {
+export type ListRouteGetResponse = {
   /**
    * Indicates the response contains a route object. Will always contain the string `route` for this endpoint.
    */
@@ -80,11 +76,11 @@ export type RouteGetResponse = {
   /**
    * The destination of the route.
    */
-  destination: RouteGetResponseDestination;
+  destination: ListRouteGetResponseDestination;
   /**
    * An object with several relevant URLs. Every URL object will contain an `href` and a `type` field.
    */
-  links: RouteGetResponseLinks;
+  links: ListRouteGetResponseLinks;
   /**
    * The entity's date and time of creation, in [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) format.
    */
@@ -92,8 +88,8 @@ export type RouteGetResponse = {
 };
 
 /** @internal */
-export const RouteGetResponseDestination$inboundSchema: z.ZodType<
-  RouteGetResponseDestination,
+export const ListRouteGetResponseDestination$inboundSchema: z.ZodType<
+  ListRouteGetResponseDestination,
   z.ZodTypeDef,
   unknown
 > = z.object({
@@ -101,85 +97,82 @@ export const RouteGetResponseDestination$inboundSchema: z.ZodType<
   organizationId: z.string(),
 });
 /** @internal */
-export type RouteGetResponseDestination$Outbound = {
+export type ListRouteGetResponseDestination$Outbound = {
   type: string;
   organizationId: string;
 };
 
 /** @internal */
-export const RouteGetResponseDestination$outboundSchema: z.ZodType<
-  RouteGetResponseDestination$Outbound,
+export const ListRouteGetResponseDestination$outboundSchema: z.ZodType<
+  ListRouteGetResponseDestination$Outbound,
   z.ZodTypeDef,
-  RouteGetResponseDestination
+  ListRouteGetResponseDestination
 > = z.object({
   type: RouteDestinationTypeResponse$outboundSchema,
   organizationId: z.string(),
 });
 
-export function routeGetResponseDestinationToJSON(
-  routeGetResponseDestination: RouteGetResponseDestination,
+export function listRouteGetResponseDestinationToJSON(
+  listRouteGetResponseDestination: ListRouteGetResponseDestination,
 ): string {
   return JSON.stringify(
-    RouteGetResponseDestination$outboundSchema.parse(
-      routeGetResponseDestination,
+    ListRouteGetResponseDestination$outboundSchema.parse(
+      listRouteGetResponseDestination,
     ),
   );
 }
-export function routeGetResponseDestinationFromJSON(
+export function listRouteGetResponseDestinationFromJSON(
   jsonString: string,
-): SafeParseResult<RouteGetResponseDestination, SDKValidationError> {
+): SafeParseResult<ListRouteGetResponseDestination, SDKValidationError> {
   return safeParse(
     jsonString,
-    (x) => RouteGetResponseDestination$inboundSchema.parse(JSON.parse(x)),
-    `Failed to parse 'RouteGetResponseDestination' from JSON`,
+    (x) => ListRouteGetResponseDestination$inboundSchema.parse(JSON.parse(x)),
+    `Failed to parse 'ListRouteGetResponseDestination' from JSON`,
   );
 }
 
 /** @internal */
-export const RouteGetResponseLinks$inboundSchema: z.ZodType<
-  RouteGetResponseLinks,
+export const ListRouteGetResponseLinks$inboundSchema: z.ZodType<
+  ListRouteGetResponseLinks,
   z.ZodTypeDef,
   unknown
 > = z.object({
   self: Url$inboundSchema,
-  documentation: Url$inboundSchema,
 });
 /** @internal */
-export type RouteGetResponseLinks$Outbound = {
+export type ListRouteGetResponseLinks$Outbound = {
   self: Url$Outbound;
-  documentation: Url$Outbound;
 };
 
 /** @internal */
-export const RouteGetResponseLinks$outboundSchema: z.ZodType<
-  RouteGetResponseLinks$Outbound,
+export const ListRouteGetResponseLinks$outboundSchema: z.ZodType<
+  ListRouteGetResponseLinks$Outbound,
   z.ZodTypeDef,
-  RouteGetResponseLinks
+  ListRouteGetResponseLinks
 > = z.object({
   self: Url$outboundSchema,
-  documentation: Url$outboundSchema,
 });
 
-export function routeGetResponseLinksToJSON(
-  routeGetResponseLinks: RouteGetResponseLinks,
+export function listRouteGetResponseLinksToJSON(
+  listRouteGetResponseLinks: ListRouteGetResponseLinks,
 ): string {
   return JSON.stringify(
-    RouteGetResponseLinks$outboundSchema.parse(routeGetResponseLinks),
+    ListRouteGetResponseLinks$outboundSchema.parse(listRouteGetResponseLinks),
   );
 }
-export function routeGetResponseLinksFromJSON(
+export function listRouteGetResponseLinksFromJSON(
   jsonString: string,
-): SafeParseResult<RouteGetResponseLinks, SDKValidationError> {
+): SafeParseResult<ListRouteGetResponseLinks, SDKValidationError> {
   return safeParse(
     jsonString,
-    (x) => RouteGetResponseLinks$inboundSchema.parse(JSON.parse(x)),
-    `Failed to parse 'RouteGetResponseLinks' from JSON`,
+    (x) => ListRouteGetResponseLinks$inboundSchema.parse(JSON.parse(x)),
+    `Failed to parse 'ListRouteGetResponseLinks' from JSON`,
   );
 }
 
 /** @internal */
-export const RouteGetResponse$inboundSchema: z.ZodType<
-  RouteGetResponse,
+export const ListRouteGetResponse$inboundSchema: z.ZodType<
+  ListRouteGetResponse,
   z.ZodTypeDef,
   unknown
 > = z.object({
@@ -188,8 +181,8 @@ export const RouteGetResponse$inboundSchema: z.ZodType<
   paymentId: z.string(),
   amount: Amount$inboundSchema,
   description: z.string(),
-  destination: z.lazy(() => RouteGetResponseDestination$inboundSchema),
-  _links: z.lazy(() => RouteGetResponseLinks$inboundSchema),
+  destination: z.lazy(() => ListRouteGetResponseDestination$inboundSchema),
+  _links: z.lazy(() => ListRouteGetResponseLinks$inboundSchema),
   createdAt: z.string(),
 }).transform((v) => {
   return remap$(v, {
@@ -197,30 +190,30 @@ export const RouteGetResponse$inboundSchema: z.ZodType<
   });
 });
 /** @internal */
-export type RouteGetResponse$Outbound = {
+export type ListRouteGetResponse$Outbound = {
   resource: string;
   id: string;
   paymentId: string;
   amount: Amount$Outbound;
   description: string;
-  destination: RouteGetResponseDestination$Outbound;
-  _links: RouteGetResponseLinks$Outbound;
+  destination: ListRouteGetResponseDestination$Outbound;
+  _links: ListRouteGetResponseLinks$Outbound;
   createdAt: string;
 };
 
 /** @internal */
-export const RouteGetResponse$outboundSchema: z.ZodType<
-  RouteGetResponse$Outbound,
+export const ListRouteGetResponse$outboundSchema: z.ZodType<
+  ListRouteGetResponse$Outbound,
   z.ZodTypeDef,
-  RouteGetResponse
+  ListRouteGetResponse
 > = z.object({
   resource: z.string(),
   id: z.string(),
   paymentId: z.string(),
   amount: Amount$outboundSchema,
   description: z.string(),
-  destination: z.lazy(() => RouteGetResponseDestination$outboundSchema),
-  links: z.lazy(() => RouteGetResponseLinks$outboundSchema),
+  destination: z.lazy(() => ListRouteGetResponseDestination$outboundSchema),
+  links: z.lazy(() => ListRouteGetResponseLinks$outboundSchema),
   createdAt: z.string(),
 }).transform((v) => {
   return remap$(v, {
@@ -228,19 +221,19 @@ export const RouteGetResponse$outboundSchema: z.ZodType<
   });
 });
 
-export function routeGetResponseToJSON(
-  routeGetResponse: RouteGetResponse,
+export function listRouteGetResponseToJSON(
+  listRouteGetResponse: ListRouteGetResponse,
 ): string {
   return JSON.stringify(
-    RouteGetResponse$outboundSchema.parse(routeGetResponse),
+    ListRouteGetResponse$outboundSchema.parse(listRouteGetResponse),
   );
 }
-export function routeGetResponseFromJSON(
+export function listRouteGetResponseFromJSON(
   jsonString: string,
-): SafeParseResult<RouteGetResponse, SDKValidationError> {
+): SafeParseResult<ListRouteGetResponse, SDKValidationError> {
   return safeParse(
     jsonString,
-    (x) => RouteGetResponse$inboundSchema.parse(JSON.parse(x)),
-    `Failed to parse 'RouteGetResponse' from JSON`,
+    (x) => ListRouteGetResponse$inboundSchema.parse(JSON.parse(x)),
+    `Failed to parse 'ListRouteGetResponse' from JSON`,
   );
 }