Class ConsumersService

Hierarchy

  • ConsumersService

Constructors

constructor

Methods

createConsumer deleteConsumer getConsumer getConsumers updateConsumer

Constructors

constructor

Methods

Static createConsumer

  • Create a consumer Use this API to create a consumer.

    Token Permissions: [ application:update:* ]

    Returns

    ConsumerResponse Created a consumer. Returns the newly saved consumer in the response body.

    Throws

    ApiError

    Parameters

    • __namedParameters: {
          requestBody: Consumer;
          xContextId?: string;
      }
      • requestBody: Consumer

        The consumer. *

      • Optional xContextId?: string

        Optional context id the request is running. *

    Returns CancelablePromise<ConsumerResponse>

Static deleteConsumer

  • Delete a consumer Use this API to delete a consumer.

    Token Permissions: [ application:update:* ]

    Returns

    void

    Throws

    ApiError

    Parameters

    • __namedParameters: {
          id: string;
          xContextId?: string;
      }
      • id: string

        The ID of the consumer *

      • Optional xContextId?: string

        Optional context id the request is running. *

    Returns CancelablePromise<void>

Static getConsumer

  • Get a consumer Use this API to get a single consumer by its ID.

    Token Permissions: [ application:get:* ]

    Returns

    ConsumerResponse The consumer.

    Throws

    ApiError

    Parameters

    • __namedParameters: {
          id: string;
          xContextId?: string;
      }
      • id: string

        The ID of the consumer. *

      • Optional xContextId?: string

        Optional context id the request is running. *

    Returns CancelablePromise<ConsumerResponse>

Static getConsumers

  • Get a list of consumers Use this API to get a list of consumers that match the given parameters.

    Token Permissions: [ event_designer:access ]

    Returns

    ConsumersResponse Get a list of consumers and the accompanying metadata.

    Throws

    ApiError

    Parameters

    • __namedParameters: {
          applicationVersionIds?: string[];
          ids?: string[];
          pageNumber?: number;
          pageSize?: number;
          xContextId?: string;
      }
      • Optional applicationVersionIds?: string[]

        Match only consumers with the given application version IDs, separated by commas. *

      • Optional ids?: string[]

        Match only consumers with the given IDs separated by commas. *

      • Optional pageNumber?: number

        The page number to get. *

      • Optional pageSize?: number

        The number of consumers to get per page. *

      • Optional xContextId?: string

        Optional context id the request is running. *

    Returns CancelablePromise<ConsumersResponse>

Static updateConsumer

  • Update a consumer Use this API to update a consumer.

    Token Permissions: [ application:update:* ]

    Returns

    ConsumerResponse Updated a consumer. Returns the newly saved consumer in the response body.

    Throws

    ApiError

    Parameters

    • __namedParameters: {
          id: string;
          requestBody: Consumer;
          xContextId?: string;
      }
      • id: string

        The ID of the consumer. *

      • requestBody: Consumer

        The consumer. *

      • Optional xContextId?: string

        Optional context id the request is running. *

    Returns CancelablePromise<ConsumerResponse>

Settings

Member Visibility

Theme