@peable.to/contracts 0.4.0 → 1.0.0

package/dist/types/resources/checkout/merchants.d.ts

@@ -0,0 +1,395 @@
+import { z } from 'zod';
+import { type Expand } from '../../common/objects';
+/**
+ * The merchant (`merch_…`) — one per Oxy application and environment — with
+ * its branding and customer-email settings. `next_derivation_index` is never
+ * on the wire: it is an internal derivation counter with no meaning to an
+ * integration. Where events go is not a merchant field: it is the
+ * `webhook_endpoint` resource.
+ */
+export declare const merchantSchema: z.ZodObject<{
+    id: z.ZodString;
+    object: z.ZodLiteral<"merchant">;
+    livemode: z.ZodBoolean;
+    oxy_app_id: z.ZodString;
+    environment: z.ZodEnum<{
+        development: "development";
+        staging: "staging";
+        production: "production";
+    }>;
+    network: z.ZodNullable<z.ZodEnum<{
+        mainnet: "mainnet";
+        testnet: "testnet";
+    }>>;
+    xpub: z.ZodNullable<z.ZodString>;
+    required_confirmations: z.ZodNumber;
+    display_name: z.ZodOptional<z.ZodString>;
+    avatar_file_id: z.ZodOptional<z.ZodString>;
+    business_logo: z.ZodOptional<z.ZodString>;
+    description: z.ZodOptional<z.ZodString>;
+    created: z.ZodNumber;
+    updated_at: z.ZodNumber;
+}, z.core.$strict>;
+export type Merchant = Expand<z.output<typeof merchantSchema>>;
+declare module '../../common/objects' {
+    interface ObjectMap {
+        merchant: Merchant;
+        branding_settings: MerchantBranding;
+        email_settings: MerchantEmailSettings;
+    }
+}
+/**
+ * `POST /v1/merchants`. The FairCoin half is OPTIONAL — both `network` and
+ * `xpub`, or neither: a card-only merchant supplies no key for a chain it
+ * never intends to use.
+ */
+export declare const registerMerchantParams: z.ZodObject<{
+    network: z.ZodOptional<z.ZodEnum<{
+        mainnet: "mainnet";
+        testnet: "testnet";
+    }>>;
+    xpub: z.ZodOptional<z.ZodString>;
+    required_confirmations: z.ZodOptional<z.ZodNumber>;
+    display_name: z.ZodOptional<z.ZodString>;
+    avatar_file_id: z.ZodOptional<z.ZodString>;
+    description: z.ZodOptional<z.ZodString>;
+}, z.core.$strict>;
+export type RegisterMerchantParams = z.input<typeof registerMerchantParams>;
+/**
+ * `POST /v1/merchants/me`. `null` clears a field. The key, network and
+ * environment never change: addresses already derived from the key, and the
+ * test/live firewall, depend on them.
+ */
+export declare const updateMerchantParams: z.ZodObject<{
+    required_confirmations: z.ZodOptional<z.ZodNumber>;
+    display_name: z.ZodOptional<z.ZodNullable<z.ZodString>>;
+    avatar_file_id: z.ZodOptional<z.ZodNullable<z.ZodString>>;
+    business_logo: z.ZodOptional<z.ZodNullable<z.ZodString>>;
+    description: z.ZodOptional<z.ZodNullable<z.ZodString>>;
+}, z.core.$strict>;
+export type UpdateMerchantParams = z.input<typeof updateMerchantParams>;
+/** A merchant's branding: what its hosted checkout, embedded checkout and receipts look like. */
+export declare const merchantBrandingSchema: z.ZodObject<{
+    object: z.ZodLiteral<"branding_settings">;
+    livemode: z.ZodBoolean;
+    use_avatar_as_icon: z.ZodBoolean;
+    logo: z.ZodNullable<z.ZodString>;
+    primary_color: z.ZodNullable<z.ZodString>;
+    accent_color: z.ZodNullable<z.ZodString>;
+    font: z.ZodNullable<z.ZodEnum<{
+        system: "system";
+        inter: "inter";
+        roboto: "roboto";
+        open_sans: "open_sans";
+        lato: "lato";
+        source_sans: "source_sans";
+        noto_sans: "noto_sans";
+        serif: "serif";
+        monospace: "monospace";
+    }>>;
+    border_style: z.ZodNullable<z.ZodEnum<{
+        rounded: "rounded";
+        rectangular: "rectangular";
+        pill: "pill";
+    }>>;
+    terms_of_service_url: z.ZodNullable<z.ZodString>;
+    updated_at: z.ZodNullable<z.ZodNumber>;
+}, z.core.$strict>;
+export type MerchantBranding = z.output<typeof merchantBrandingSchema>;
+export declare const updateMerchantBrandingParams: z.ZodObject<{
+    use_avatar_as_icon: z.ZodOptional<z.ZodBoolean>;
+    logo: z.ZodOptional<z.ZodNullable<z.ZodString>>;
+    primary_color: z.ZodOptional<z.ZodNullable<z.ZodPipe<z.ZodString, z.ZodTransform<string, string>>>>;
+    accent_color: z.ZodOptional<z.ZodNullable<z.ZodPipe<z.ZodString, z.ZodTransform<string, string>>>>;
+    font: z.ZodOptional<z.ZodNullable<z.ZodEnum<{
+        system: "system";
+        inter: "inter";
+        roboto: "roboto";
+        open_sans: "open_sans";
+        lato: "lato";
+        source_sans: "source_sans";
+        noto_sans: "noto_sans";
+        serif: "serif";
+        monospace: "monospace";
+    }>>>;
+    border_style: z.ZodOptional<z.ZodNullable<z.ZodEnum<{
+        rounded: "rounded";
+        rectangular: "rectangular";
+        pill: "pill";
+    }>>>;
+    terms_of_service_url: z.ZodOptional<z.ZodNullable<z.ZodString>>;
+}, z.core.$strict>;
+export type UpdateMerchantBrandingParams = z.input<typeof updateMerchantBrandingParams>;
+/** Which customer emails Peable sends for this merchant. */
+export declare const merchantEmailSettingsSchema: z.ZodObject<{
+    object: z.ZodLiteral<"email_settings">;
+    livemode: z.ZodBoolean;
+    payment_receipts: z.ZodBoolean;
+    refund_notices: z.ZodBoolean;
+    checkout_confirmations: z.ZodBoolean;
+    support_email: z.ZodNullable<z.ZodString>;
+    updated_at: z.ZodNullable<z.ZodNumber>;
+}, z.core.$strict>;
+export type MerchantEmailSettings = z.output<typeof merchantEmailSettingsSchema>;
+export declare const updateMerchantEmailSettingsParams: z.ZodObject<{
+    payment_receipts: z.ZodOptional<z.ZodBoolean>;
+    refund_notices: z.ZodOptional<z.ZodBoolean>;
+    checkout_confirmations: z.ZodOptional<z.ZodBoolean>;
+    support_email: z.ZodOptional<z.ZodNullable<z.ZodString>>;
+}, z.core.$strict>;
+export type UpdateMerchantEmailSettingsParams = z.input<typeof updateMerchantEmailSettingsParams>;
+export declare const merchantRoutes: readonly [{
+    readonly operationId: "registerMerchant";
+    readonly method: "post";
+    readonly path: "/v1/merchants";
+    readonly tag: "Merchants";
+    readonly summary: "Register the merchant";
+    readonly description: "Registers the calling application's merchant in the credential's environment. A non-production credential can register a testnet merchant only. A second registration for the same application and environment answers 409. Outside the generic idempotency layer: the merchant is the scope it keys on.";
+    readonly auth: "service";
+    readonly scope: "payments:write";
+    readonly body: z.ZodObject<{
+        network: z.ZodOptional<z.ZodEnum<{
+            mainnet: "mainnet";
+            testnet: "testnet";
+        }>>;
+        xpub: z.ZodOptional<z.ZodString>;
+        required_confirmations: z.ZodOptional<z.ZodNumber>;
+        display_name: z.ZodOptional<z.ZodString>;
+        avatar_file_id: z.ZodOptional<z.ZodString>;
+        description: z.ZodOptional<z.ZodString>;
+    }, z.core.$strict>;
+    readonly response: z.ZodObject<{
+        id: z.ZodString;
+        object: z.ZodLiteral<"merchant">;
+        livemode: z.ZodBoolean;
+        oxy_app_id: z.ZodString;
+        environment: z.ZodEnum<{
+            development: "development";
+            staging: "staging";
+            production: "production";
+        }>;
+        network: z.ZodNullable<z.ZodEnum<{
+            mainnet: "mainnet";
+            testnet: "testnet";
+        }>>;
+        xpub: z.ZodNullable<z.ZodString>;
+        required_confirmations: z.ZodNumber;
+        display_name: z.ZodOptional<z.ZodString>;
+        avatar_file_id: z.ZodOptional<z.ZodString>;
+        business_logo: z.ZodOptional<z.ZodString>;
+        description: z.ZodOptional<z.ZodString>;
+        created: z.ZodNumber;
+        updated_at: z.ZodNumber;
+    }, z.core.$strict>;
+    readonly status: 201;
+    readonly sdk: "merchants.register";
+}, {
+    readonly operationId: "retrieveMerchant";
+    readonly method: "get";
+    readonly path: "/v1/merchants/me";
+    readonly tag: "Merchants";
+    readonly summary: "Retrieve your merchant";
+    readonly auth: "service";
+    readonly scope: "payments:read";
+    readonly response: z.ZodObject<{
+        id: z.ZodString;
+        object: z.ZodLiteral<"merchant">;
+        livemode: z.ZodBoolean;
+        oxy_app_id: z.ZodString;
+        environment: z.ZodEnum<{
+            development: "development";
+            staging: "staging";
+            production: "production";
+        }>;
+        network: z.ZodNullable<z.ZodEnum<{
+            mainnet: "mainnet";
+            testnet: "testnet";
+        }>>;
+        xpub: z.ZodNullable<z.ZodString>;
+        required_confirmations: z.ZodNumber;
+        display_name: z.ZodOptional<z.ZodString>;
+        avatar_file_id: z.ZodOptional<z.ZodString>;
+        business_logo: z.ZodOptional<z.ZodString>;
+        description: z.ZodOptional<z.ZodString>;
+        created: z.ZodNumber;
+        updated_at: z.ZodNumber;
+    }, z.core.$strict>;
+    readonly sdk: "merchants.retrieve";
+}, {
+    readonly operationId: "updateMerchant";
+    readonly method: "post";
+    readonly path: "/v1/merchants/me";
+    readonly tag: "Merchants";
+    readonly summary: "Update your merchant";
+    readonly auth: "service";
+    readonly scope: "payments:write";
+    readonly idempotent: true;
+    readonly body: z.ZodObject<{
+        required_confirmations: z.ZodOptional<z.ZodNumber>;
+        display_name: z.ZodOptional<z.ZodNullable<z.ZodString>>;
+        avatar_file_id: z.ZodOptional<z.ZodNullable<z.ZodString>>;
+        business_logo: z.ZodOptional<z.ZodNullable<z.ZodString>>;
+        description: z.ZodOptional<z.ZodNullable<z.ZodString>>;
+    }, z.core.$strict>;
+    readonly response: z.ZodObject<{
+        id: z.ZodString;
+        object: z.ZodLiteral<"merchant">;
+        livemode: z.ZodBoolean;
+        oxy_app_id: z.ZodString;
+        environment: z.ZodEnum<{
+            development: "development";
+            staging: "staging";
+            production: "production";
+        }>;
+        network: z.ZodNullable<z.ZodEnum<{
+            mainnet: "mainnet";
+            testnet: "testnet";
+        }>>;
+        xpub: z.ZodNullable<z.ZodString>;
+        required_confirmations: z.ZodNumber;
+        display_name: z.ZodOptional<z.ZodString>;
+        avatar_file_id: z.ZodOptional<z.ZodString>;
+        business_logo: z.ZodOptional<z.ZodString>;
+        description: z.ZodOptional<z.ZodString>;
+        created: z.ZodNumber;
+        updated_at: z.ZodNumber;
+    }, z.core.$strict>;
+    readonly sdk: "merchants.update";
+}, {
+    readonly operationId: "retrieveBrandingSettings";
+    readonly method: "get";
+    readonly path: "/v1/merchants/me/branding";
+    readonly tag: "Merchants";
+    readonly summary: "Retrieve your branding";
+    readonly auth: "service";
+    readonly scope: "payments:read";
+    readonly response: z.ZodObject<{
+        object: z.ZodLiteral<"branding_settings">;
+        livemode: z.ZodBoolean;
+        use_avatar_as_icon: z.ZodBoolean;
+        logo: z.ZodNullable<z.ZodString>;
+        primary_color: z.ZodNullable<z.ZodString>;
+        accent_color: z.ZodNullable<z.ZodString>;
+        font: z.ZodNullable<z.ZodEnum<{
+            system: "system";
+            inter: "inter";
+            roboto: "roboto";
+            open_sans: "open_sans";
+            lato: "lato";
+            source_sans: "source_sans";
+            noto_sans: "noto_sans";
+            serif: "serif";
+            monospace: "monospace";
+        }>>;
+        border_style: z.ZodNullable<z.ZodEnum<{
+            rounded: "rounded";
+            rectangular: "rectangular";
+            pill: "pill";
+        }>>;
+        terms_of_service_url: z.ZodNullable<z.ZodString>;
+        updated_at: z.ZodNullable<z.ZodNumber>;
+    }, z.core.$strict>;
+    readonly sdk: "merchants.branding.retrieve";
+}, {
+    readonly operationId: "updateBrandingSettings";
+    readonly method: "post";
+    readonly path: "/v1/merchants/me/branding";
+    readonly tag: "Merchants";
+    readonly summary: "Update your branding";
+    readonly auth: "service";
+    readonly scope: "payments:write";
+    readonly idempotent: true;
+    readonly body: z.ZodObject<{
+        use_avatar_as_icon: z.ZodOptional<z.ZodBoolean>;
+        logo: z.ZodOptional<z.ZodNullable<z.ZodString>>;
+        primary_color: z.ZodOptional<z.ZodNullable<z.ZodPipe<z.ZodString, z.ZodTransform<string, string>>>>;
+        accent_color: z.ZodOptional<z.ZodNullable<z.ZodPipe<z.ZodString, z.ZodTransform<string, string>>>>;
+        font: z.ZodOptional<z.ZodNullable<z.ZodEnum<{
+            system: "system";
+            inter: "inter";
+            roboto: "roboto";
+            open_sans: "open_sans";
+            lato: "lato";
+            source_sans: "source_sans";
+            noto_sans: "noto_sans";
+            serif: "serif";
+            monospace: "monospace";
+        }>>>;
+        border_style: z.ZodOptional<z.ZodNullable<z.ZodEnum<{
+            rounded: "rounded";
+            rectangular: "rectangular";
+            pill: "pill";
+        }>>>;
+        terms_of_service_url: z.ZodOptional<z.ZodNullable<z.ZodString>>;
+    }, z.core.$strict>;
+    readonly response: z.ZodObject<{
+        object: z.ZodLiteral<"branding_settings">;
+        livemode: z.ZodBoolean;
+        use_avatar_as_icon: z.ZodBoolean;
+        logo: z.ZodNullable<z.ZodString>;
+        primary_color: z.ZodNullable<z.ZodString>;
+        accent_color: z.ZodNullable<z.ZodString>;
+        font: z.ZodNullable<z.ZodEnum<{
+            system: "system";
+            inter: "inter";
+            roboto: "roboto";
+            open_sans: "open_sans";
+            lato: "lato";
+            source_sans: "source_sans";
+            noto_sans: "noto_sans";
+            serif: "serif";
+            monospace: "monospace";
+        }>>;
+        border_style: z.ZodNullable<z.ZodEnum<{
+            rounded: "rounded";
+            rectangular: "rectangular";
+            pill: "pill";
+        }>>;
+        terms_of_service_url: z.ZodNullable<z.ZodString>;
+        updated_at: z.ZodNullable<z.ZodNumber>;
+    }, z.core.$strict>;
+    readonly sdk: "merchants.branding.update";
+}, {
+    readonly operationId: "retrieveEmailSettings";
+    readonly method: "get";
+    readonly path: "/v1/merchants/me/email_settings";
+    readonly tag: "Merchants";
+    readonly summary: "Retrieve your customer email settings";
+    readonly auth: "service";
+    readonly scope: "payments:read";
+    readonly response: z.ZodObject<{
+        object: z.ZodLiteral<"email_settings">;
+        livemode: z.ZodBoolean;
+        payment_receipts: z.ZodBoolean;
+        refund_notices: z.ZodBoolean;
+        checkout_confirmations: z.ZodBoolean;
+        support_email: z.ZodNullable<z.ZodString>;
+        updated_at: z.ZodNullable<z.ZodNumber>;
+    }, z.core.$strict>;
+    readonly sdk: "merchants.emailSettings.retrieve";
+}, {
+    readonly operationId: "updateEmailSettings";
+    readonly method: "post";
+    readonly path: "/v1/merchants/me/email_settings";
+    readonly tag: "Merchants";
+    readonly summary: "Update your customer email settings";
+    readonly auth: "service";
+    readonly scope: "payments:write";
+    readonly idempotent: true;
+    readonly body: z.ZodObject<{
+        payment_receipts: z.ZodOptional<z.ZodBoolean>;
+        refund_notices: z.ZodOptional<z.ZodBoolean>;
+        checkout_confirmations: z.ZodOptional<z.ZodBoolean>;
+        support_email: z.ZodOptional<z.ZodNullable<z.ZodString>>;
+    }, z.core.$strict>;
+    readonly response: z.ZodObject<{
+        object: z.ZodLiteral<"email_settings">;
+        livemode: z.ZodBoolean;
+        payment_receipts: z.ZodBoolean;
+        refund_notices: z.ZodBoolean;
+        checkout_confirmations: z.ZodBoolean;
+        support_email: z.ZodNullable<z.ZodString>;
+        updated_at: z.ZodNullable<z.ZodNumber>;
+    }, z.core.$strict>;
+    readonly sdk: "merchants.emailSettings.update";
+}];