Class PrimarySalesApi

Hierarchy

  • PrimarySalesApi
    • PrimarySalesApi

Constructors

constructor

Properties

basePath axios configuration

Methods

acceptPrimarySale createPrimarySale getPrimarySale rejectPrimarySale signableAcceptPrimarySale signableCreatePrimarySale signableRejectPrimarySale

Constructors

constructor

  • Parameters

    • Optional configuration: Configuration
    • Optional basePath: string
    • Optional axios: AxiosInstance

    Returns x.PrimarySalesApi

Properties

Protected basePath

basePath: string

Protected axios

axios: AxiosInstance

Protected configuration

configuration: undefined | Configuration

Methods

acceptPrimarySale

  • Accept Primary Sale. This endpoint is experimental and may change in the future.

    Parameters

    • requestParameters: PrimarySalesApiAcceptPrimarySaleRequest

      Request parameters.

    • Optional options: AxiosRequestConfig<any>

      Override http request option.

    Returns Promise<AxiosResponse<AcceptPrimarySaleOKBody, any>>

    Summary

    Accept Primary Sale

    Throws

    Memberof

    PrimarySalesApi

createPrimarySale

  • Create Primary Sale. This endpoint is experimental and may change in the future.

    Parameters

    • Optional requestParameters: PrimarySalesApiCreatePrimarySaleRequest

      Request parameters.

    • Optional options: AxiosRequestConfig<any>

      Override http request option.

    Returns Promise<AxiosResponse<CreatePrimarySaleCreatedBody, any>>

    Summary

    Create Primary Sale

    Throws

    Memberof

    PrimarySalesApi

getPrimarySale

  • Get a single primary sale by ID. This endpoint is experimental and may change in the future.

    Parameters

    • requestParameters: PrimarySalesApiGetPrimarySaleRequest

      Request parameters.

    • Optional options: AxiosRequestConfig<any>

      Override http request option.

    Returns Promise<AxiosResponse<GetPrimarySaleOKBody, any>>

    Summary

    Get a single primary sale by ID

    Throws

    Memberof

    PrimarySalesApi

rejectPrimarySale

  • Reject Primary Sale. This endpoint is experimental and may change in the future.

    Parameters

    • requestParameters: PrimarySalesApiRejectPrimarySaleRequest

      Request parameters.

    • Optional options: AxiosRequestConfig<any>

      Override http request option.

    Returns Promise<AxiosResponse<RejectPrimarySaleOKBody, any>>

    Summary

    Reject Primary Sale

    Throws

    Memberof

    PrimarySalesApi

signableAcceptPrimarySale

  • Signable Accept Primary Sale. This endpoint is experimental and may change in the future.

    Parameters

    • requestParameters: PrimarySalesApiSignableAcceptPrimarySaleRequest

      Request parameters.

    • Optional options: AxiosRequestConfig<any>

      Override http request option.

    Returns Promise<AxiosResponse<SignableAcceptPrimarySaleOKBody, any>>

    Summary

    Signable Accept Primary Sale

    Throws

    Memberof

    PrimarySalesApi

signableCreatePrimarySale

  • Signable Create Primary Sale. This endpoint is experimental and may change in the future.

    Parameters

    • Optional requestParameters: PrimarySalesApiSignableCreatePrimarySaleRequest

      Request parameters.

    • Optional options: AxiosRequestConfig<any>

      Override http request option.

    Returns Promise<AxiosResponse<SignableCreatePrimarySaleOKBody, any>>

    Summary

    Signable Create Primary Sale

    Throws

    Memberof

    PrimarySalesApi

signableRejectPrimarySale

  • Signable Reject Primary Sale. This endpoint is experimental and may change in the future.

    Parameters

    • requestParameters: PrimarySalesApiSignableRejectPrimarySaleRequest

      Request parameters.

    • Optional options: AxiosRequestConfig<any>

      Override http request option.

    Returns Promise<AxiosResponse<SignableRejectPrimarySaleOKBody, any>>

    Summary

    Signable Reject Primary Sale

    Throws

    Memberof

    PrimarySalesApi

Settings

Member Visibility

Theme

On This Page

Generated using TypeDoc