stripe/types/Terminal/OnboardingLinksResource.d.ts

Stripe API wrapper

// File generated from our OpenAPI spec

declare module 'stripe' {
  namespace Stripe {
    namespace Terminal {
      interface OnboardingLinkCreateParams {
        /**
         * Specific fields needed to generate the desired link type.
         */
        link_options: OnboardingLinkCreateParams.LinkOptions;

        /**
         * The type of link being generated.
         */
        link_type: 'apple_terms_and_conditions';

        /**
         * Specifies which fields in the response should be expanded.
         */
        expand?: Array<string>;

        /**
         * Stripe account ID to generate the link for.
         */
        on_behalf_of?: string;
      }

      namespace OnboardingLinkCreateParams {
        interface LinkOptions {
          /**
           * The options associated with the Apple Terms and Conditions link type.
           */
          apple_terms_and_conditions?: LinkOptions.AppleTermsAndConditions;
        }

        namespace LinkOptions {
          interface AppleTermsAndConditions {
            /**
             * Whether the link should also support users relinking their Apple account.
             */
            allow_relinking?: boolean;

            /**
             * The business name of the merchant accepting Apple's Terms and Conditions.
             */
            merchant_display_name: string;
          }
        }
      }

      class OnboardingLinksResource {
        /**
         * Creates a new OnboardingLink object that contains a redirect_url used for onboarding onto Tap to Pay on iPhone.
         */
        create(
          params: OnboardingLinkCreateParams,
          options?: RequestOptions
        ): Promise<Stripe.Response<Stripe.Terminal.OnboardingLink>>;
      }
    }
  }
}