Function FeedsApiAxiosParamCreator

FeedsApi - axios parameter creator

Export

  • FeedsApiAxiosParamCreator(
        configuration?: Configuration,
    ): {
        cancelFeed: (
            feedId: string,
            options?: RawAxiosRequestConfig,
        ) => Promise<RequestArgs>;
        createFeed: (
            body: CreateFeedSpecification,
            options?: RawAxiosRequestConfig,
        ) => Promise<RequestArgs>;
        createFeedDocument: (
            body: CreateFeedDocumentSpecification,
            options?: RawAxiosRequestConfig,
        ) => Promise<RequestArgs>;
        getFeed: (
            feedId: string,
            options?: RawAxiosRequestConfig,
        ) => Promise<RequestArgs>;
        getFeedDocument: (
            feedDocumentId: string,
            options?: RawAxiosRequestConfig,
        ) => Promise<RequestArgs>;
        getFeeds: (
            feedTypes?: string[],
            marketplaceIds?: string[],
            pageSize?: number,
            processingStatuses?: GetFeedsProcessingStatusesEnum[],
            createdSince?: string,
            createdUntil?: string,
            nextToken?: string,
            options?: RawAxiosRequestConfig,
        ) => Promise<RequestArgs>;
    }

  • Parameters

    • Optionalconfiguration: Configuration

    Returns {
        cancelFeed: (
            feedId: string,
            options?: RawAxiosRequestConfig,
        ) => Promise<RequestArgs>;
        createFeed: (
            body: CreateFeedSpecification,
            options?: RawAxiosRequestConfig,
        ) => Promise<RequestArgs>;
        createFeedDocument: (
            body: CreateFeedDocumentSpecification,
            options?: RawAxiosRequestConfig,
        ) => Promise<RequestArgs>;
        getFeed: (
            feedId: string,
            options?: RawAxiosRequestConfig,
        ) => Promise<RequestArgs>;
        getFeedDocument: (
            feedDocumentId: string,
            options?: RawAxiosRequestConfig,
        ) => Promise<RequestArgs>;
        getFeeds: (
            feedTypes?: string[],
            marketplaceIds?: string[],
            pageSize?: number,
            processingStatuses?: GetFeedsProcessingStatusesEnum[],
            createdSince?: string,
            createdUntil?: string,
            nextToken?: string,
            options?: RawAxiosRequestConfig,
        ) => Promise<RequestArgs>;
    }

    • cancelFeed: (feedId: string, options?: RawAxiosRequestConfig) => Promise<RequestArgs>

      Cancels the feed that you specify. Only feeds with processingStatus=IN_QUEUE can be cancelled. Cancelled feeds are returned in subsequent calls to the getFeed and getFeeds operations. Usage Plan: | Rate (requests per second) | Burst | | ---- | ---- | | 2 | 15 | The x-amzn-RateLimit-Limit response header returns the usage plan rate limits that were applied to the requested operation, when available. The preceding table indicates the default rate and burst values for this operation. Selling partners whose business demands require higher throughput may have higher rate and burst values than those shown here. For more information, refer to Usage Plans and Rate Limits in the Selling Partner API.

      Throws

    • createFeed: (
          body: CreateFeedSpecification,
          options?: RawAxiosRequestConfig,
      ) => Promise<RequestArgs>

      Creates a feed. Upload the contents of the feed document before calling this operation. Usage Plan: | Rate (requests per second) | Burst | | ---- | ---- | | 0.0083 | 15 | The x-amzn-RateLimit-Limit response header returns the usage plan rate limits that were applied to the requested operation, when available. The preceding table indicates the default rate and burst values for this operation. Selling partners whose business demands require higher throughput may have higher rate and burst values than those shown here. For more information, refer to Usage Plans and Rate Limits in the Selling Partner API. The rate limit for the JSON_LISTINGS_FEED feed type differs from the rate limit for the createFeed operation. For more information, refer to the Building Listings Management Workflows Guide.

      Throws

    • createFeedDocument: (
          body: CreateFeedDocumentSpecification,
          options?: RawAxiosRequestConfig,
      ) => Promise<RequestArgs>

      Creates a feed document for the feed type that you specify. This operation returns a presigned URL for uploading the feed document contents. It also returns a feedDocumentId value that you can pass in with a subsequent call to the createFeed operation. Usage Plan: | Rate (requests per second) | Burst | | ---- | ---- | | 0.5 | 15 | The x-amzn-RateLimit-Limit response header returns the usage plan rate limits that were applied to the requested operation, when available. The preceding table indicates the default rate and burst values for this operation. Selling partners whose business demands require higher throughput may have higher rate and burst values than those shown here. For more information, refer to Usage Plans and Rate Limits in the Selling Partner API.

      Throws

    • getFeed: (feedId: string, options?: RawAxiosRequestConfig) => Promise<RequestArgs>

      Returns feed details (including the resultDocumentId, if available) for the feed that you specify. Usage Plan: | Rate (requests per second) | Burst | | ---- | ---- | | 2 | 15 | The x-amzn-RateLimit-Limit response header returns the usage plan rate limits that were applied to the requested operation, when available. The preceding table indicates the default rate and burst values for this operation. Selling partners whose business demands require higher throughput may have higher rate and burst values than those shown here. For more information, refer to Usage Plans and Rate Limits in the Selling Partner API.

      Throws

    • getFeedDocument: (
          feedDocumentId: string,
          options?: RawAxiosRequestConfig,
      ) => Promise<RequestArgs>

      Returns the information required for retrieving a feed document's contents. Usage Plan: | Rate (requests per second) | Burst | | ---- | ---- | | 0.0222 | 10 | The x-amzn-RateLimit-Limit response header returns the usage plan rate limits that were applied to the requested operation, when available. The preceding table indicates the default rate and burst values for this operation. Selling partners whose business demands require higher throughput may have higher rate and burst values than those shown here. For more information, refer to Usage Plans and Rate Limits in the Selling Partner API.

      Throws

    • getFeeds: (
          feedTypes?: string[],
          marketplaceIds?: string[],
          pageSize?: number,
          processingStatuses?: GetFeedsProcessingStatusesEnum[],
          createdSince?: string,
          createdUntil?: string,
          nextToken?: string,
          options?: RawAxiosRequestConfig,
      ) => Promise<RequestArgs>

      Returns feed details for the feeds that match the filters that you specify. Usage Plan: | Rate (requests per second) | Burst | | ---- | ---- | | 0.0222 | 10 | The x-amzn-RateLimit-Limit response header returns the usage plan rate limits that were applied to the requested operation, when available. The preceding table indicates the default rate and burst values for this operation. Selling partners whose business demands require higher throughput may have higher rate and burst values than those shown here. For more information, refer to Usage Plans and Rate Limits in the Selling Partner API.

      Throws

Settings

Member Visibility