Class MockupGeneratorV2Service

constructor

• new MockupGeneratorV2Service(httpRequest): MockupGeneratorV2Service

• Parameters

  • httpRequest: BaseHttpRequest

  Returns MockupGeneratorV2Service

ReadonlyhttpRequest

createMockupGeneratorTasks

• createMockupGeneratorTasks(xPfStoreId?, requestBody?): CancelablePromise<any>

• Create Mockup Generator tasks Create Mockup Generator tasks

  Parameters

  • OptionalxPfStoreId: string

    Use this to specify which store you want to use (required only for account level token).

    The store IDs can be retrieved with the Get basic information about stores endpoint.
  • OptionalrequestBody: MockupTaskCreation

    This action schedules asynchronous mockup generation tasks. In the response of this request id will be returned which can be used to retrieve the result of the tasks Retrieve mockup generator tasks. In addition, the webhook event will be sent informing about the task completion, if the correct webhook has been subscribed to Mockup generator task finished event. You can subscribe to webhook events by using Set up event configuration.

  Returns CancelablePromise<any>

  any OK

  Throws

  ApiError

getMockupGeneratorTasks

• getMockupGeneratorTasks(id, limit?, offset?): CancelablePromise<any>

• Retrieve Mockup Generator tasks Returns result of Mockup Generator tasks

  Parameters

  • id: string[]

    One or more mockup generator task IDs to return only specified tasks. The IDs can be found in the response of the operation Create mockup generator tasks.
  • limit: number = 20

    The number of results to return per page.
  • Optionaloffset: number

    The number of results to not include in the response starting from the beginning of the list.

    This can be used to return results after the initial 100. For example, sending offset 100

  Returns CancelablePromise<any>

  any OK

  Throws

  ApiError