Function SupplySourcesApiFactory

Returns {
    archiveSupplySource(
        requestParameters: SupplySourcesApiArchiveSupplySourceRequest,
        options?: RawAxiosRequestConfig,
    ): AxiosPromise<ErrorList>;
    createSupplySource(
        requestParameters: SupplySourcesApiCreateSupplySourceRequest,
        options?: RawAxiosRequestConfig,
    ): AxiosPromise<CreateSupplySourceResponse>;
    getSupplySource(
        requestParameters: SupplySourcesApiGetSupplySourceRequest,
        options?: RawAxiosRequestConfig,
    ): AxiosPromise<SupplySource>;
    getSupplySources(
        requestParameters?: SupplySourcesApiGetSupplySourcesRequest,
        options?: RawAxiosRequestConfig,
    ): AxiosPromise<GetSupplySourcesResponse>;
    updateSupplySource(
        requestParameters: SupplySourcesApiUpdateSupplySourceRequest,
        options?: RawAxiosRequestConfig,
    ): AxiosPromise<ErrorList>;
    updateSupplySourceStatus(
        requestParameters: SupplySourcesApiUpdateSupplySourceStatusRequest,
        options?: RawAxiosRequestConfig,
    ): AxiosPromise<ErrorList>;
}

• archiveSupplySource:function

  • archiveSupplySource(
        requestParameters: SupplySourcesApiArchiveSupplySourceRequest,
        options?: RawAxiosRequestConfig,
    ): AxiosPromise<ErrorList>

    Archive a supply source, making it inactive. Cannot be undone.

    Parameters

    • requestParameters: SupplySourcesApiArchiveSupplySourceRequest

      Request parameters.
    • Optionaloptions: RawAxiosRequestConfig

      Override http request option.

    Returns AxiosPromise<ErrorList>

    Throws

• createSupplySource:function

  • createSupplySource(
        requestParameters: SupplySourcesApiCreateSupplySourceRequest,
        options?: RawAxiosRequestConfig,
    ): AxiosPromise<CreateSupplySourceResponse>

    Create a new supply source.

    Parameters

    • requestParameters: SupplySourcesApiCreateSupplySourceRequest

      Request parameters.
    • Optionaloptions: RawAxiosRequestConfig

      Override http request option.

    Returns AxiosPromise<CreateSupplySourceResponse>

    Throws

• getSupplySource:function

  • getSupplySource(
        requestParameters: SupplySourcesApiGetSupplySourceRequest,
        options?: RawAxiosRequestConfig,
    ): AxiosPromise<SupplySource>

    Retrieve a supply source.

    Parameters

    • requestParameters: SupplySourcesApiGetSupplySourceRequest

      Request parameters.
    • Optionaloptions: RawAxiosRequestConfig

      Override http request option.

    Returns AxiosPromise<SupplySource>

    Throws

• getSupplySources:function

  • getSupplySources(
        requestParameters?: SupplySourcesApiGetSupplySourcesRequest,
        options?: RawAxiosRequestConfig,
    ): AxiosPromise<GetSupplySourcesResponse>

    The path to retrieve paginated supply sources.

    Parameters

    • requestParameters: SupplySourcesApiGetSupplySourcesRequest = {}

      Request parameters.
    • Optionaloptions: RawAxiosRequestConfig

      Override http request option.

    Returns AxiosPromise<GetSupplySourcesResponse>

    Throws

• updateSupplySource:function

  • updateSupplySource(
        requestParameters: SupplySourcesApiUpdateSupplySourceRequest,
        options?: RawAxiosRequestConfig,
    ): AxiosPromise<ErrorList>

    Update the configuration and capabilities of a supply source.

    Parameters

    • requestParameters: SupplySourcesApiUpdateSupplySourceRequest

      Request parameters.
    • Optionaloptions: RawAxiosRequestConfig

      Override http request option.

    Returns AxiosPromise<ErrorList>

    Throws

• updateSupplySourceStatus:function

  • updateSupplySourceStatus(
        requestParameters: SupplySourcesApiUpdateSupplySourceStatusRequest,
        options?: RawAxiosRequestConfig,
    ): AxiosPromise<ErrorList>

    Update the status of a supply source.

    Parameters

    • requestParameters: SupplySourcesApiUpdateSupplySourceStatusRequest

      Request parameters.
    • Optionaloptions: RawAxiosRequestConfig

      Override http request option.

    Returns AxiosPromise<ErrorList>

    Throws