com.adobe.acs.commons.marketo.client.MarketoClient Maven / Gradle / Ivy

Show more of this group Show more artifacts with this name
Show all versions of acs-aem-commons-bundle Show documentation

Main ACS AEM Commons OSGi Bundle. Includes commons utilities.

There is a newer version: 6.6.0

Show newest version

/*
 * #%L
 * ACS AEM Commons Bundle
 * %%
 * Copyright (C) 2019 Adobe
 * %%
 * Licensed under the Apache License, Version 2.0 (the "License");
 * you may not use this file except in compliance with the License.
 * You may obtain a copy of the License at
 * 
 *      http://www.apache.org/licenses/LICENSE-2.0
 * 
 * Unless required by applicable law or agreed to in writing, software
 * distributed under the License is distributed on an "AS IS" BASIS,
 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
 * See the License for the specific language governing permissions and
 * limitations under the License.
 * #L%
 */
package com.adobe.acs.commons.marketo.client;

import java.io.IOException;
import java.util.List;

import javax.annotation.Nonnull;

import com.adobe.acs.commons.marketo.MarketoClientConfiguration;

/**
 * A client for interacting with Marketo's API.
 */
public interface MarketoClient {

  /**
   * Retrieve an API token used for interacting with the Marketo API.
   * 
   * @param config the configuration to use to retrieve the token
   * @return a valid Marketo API Token
   * @throws IOException an error occurs retrieving the token
   */
  public @Nonnull String getApiToken(@Nonnull MarketoClientConfiguration config) throws IOException;

  /**
   * Retrieve all of the available forms from the current organization in Marketo.
   * 
   * @param config the configuration for this request
   * @return the full list of available forms
   * @throws IOException an exception occurs interacting with the API
   */
  public @Nonnull List getForms(@Nonnull MarketoClientConfiguration config) throws IOException;

  /**
   * Retrieve all of the available forms from the current organization in Marketo.
   * 
   * @param config the configuration for this request
   * @return the full list of available forms
   * @throws IOException an exception occurs interacting with the API
   */
  public @Nonnull List getFields(@Nonnull MarketoClientConfiguration config) throws IOException;

}