Function SupplySourcesApiFp

Returns {
    archiveSupplySource(
        supplySourceId: string,
        options?: RawAxiosRequestConfig,
    ): Promise<
        (axios?: AxiosInstance, basePath?: string) => AxiosPromise<ErrorList>,
    >;
    createSupplySource(
        payload: CreateSupplySourceRequest,
        options?: RawAxiosRequestConfig,
    ): Promise<
        (
            axios?: AxiosInstance,
            basePath?: string,
        ) => AxiosPromise<CreateSupplySourceResponse>,
    >;
    getSupplySource(
        supplySourceId: string,
        options?: RawAxiosRequestConfig,
    ): Promise<
        (
            axios?: AxiosInstance,
            basePath?: string,
        ) => AxiosPromise<SupplySource>,
    >;
    getSupplySources(
        nextPageToken?: string,
        pageSize?: number,
        options?: RawAxiosRequestConfig,
    ): Promise<
        (
            axios?: AxiosInstance,
            basePath?: string,
        ) => AxiosPromise<GetSupplySourcesResponse>,
    >;
    updateSupplySource(
        supplySourceId: string,
        payload?: UpdateSupplySourceRequest,
        options?: RawAxiosRequestConfig,
    ): Promise<
        (axios?: AxiosInstance, basePath?: string) => AxiosPromise<ErrorList>,
    >;
    updateSupplySourceStatus(
        supplySourceId: string,
        payload?: UpdateSupplySourceStatusRequest,
        options?: RawAxiosRequestConfig,
    ): Promise<
        (axios?: AxiosInstance, basePath?: string) => AxiosPromise<ErrorList>,
    >;
}

• archiveSupplySource: function

  • archiveSupplySource(
        supplySourceId: string,
        options?: RawAxiosRequestConfig,
    ): Promise<
        (axios?: AxiosInstance, basePath?: string) => AxiosPromise<ErrorList>,
    >

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

    Parameters

    • supplySourceId: string

      The unique identifier of a supply source.

    • Optionaloptions: RawAxiosRequestConfig

      Override http request option.

    Returns Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<ErrorList>>

    Throws

• createSupplySource: function

  • createSupplySource(
        payload: CreateSupplySourceRequest,
        options?: RawAxiosRequestConfig,
    ): Promise<
        (
            axios?: AxiosInstance,
            basePath?: string,
        ) => AxiosPromise<CreateSupplySourceResponse>,
    >

    Create a new supply source.

    Parameters

    • payload: CreateSupplySourceRequest

      A request to create a supply source.

    • Optionaloptions: RawAxiosRequestConfig

      Override http request option.

    Returns Promise<
        (
            axios?: AxiosInstance,
            basePath?: string,
        ) => AxiosPromise<CreateSupplySourceResponse>,
    >

    Throws

• getSupplySource: function

  • getSupplySource(
        supplySourceId: string,
        options?: RawAxiosRequestConfig,
    ): Promise<
        (axios?: AxiosInstance, basePath?: string) => AxiosPromise<SupplySource>,
    >

    Retrieve a supply source.

    Parameters

    • supplySourceId: string

      The unique identifier of a supply source.

    • Optionaloptions: RawAxiosRequestConfig

      Override http request option.

    Returns Promise<
        (axios?: AxiosInstance, basePath?: string) => AxiosPromise<SupplySource>,
    >

    Throws

• getSupplySources: function

  • getSupplySources(
        nextPageToken?: string,
        pageSize?: number,
        options?: RawAxiosRequestConfig,
    ): Promise<
        (
            axios?: AxiosInstance,
            basePath?: string,
        ) => AxiosPromise<GetSupplySourcesResponse>,
    >

    The path to retrieve paginated supply sources.

    Parameters

    • OptionalnextPageToken: string

      The pagination token to retrieve a specific page of results.

    • OptionalpageSize: number

      The number of supply sources to return per paginated request.

    • Optionaloptions: RawAxiosRequestConfig

      Override http request option.

    Returns Promise<
        (
            axios?: AxiosInstance,
            basePath?: string,
        ) => AxiosPromise<GetSupplySourcesResponse>,
    >

    Throws

• updateSupplySource: function

  • updateSupplySource(
        supplySourceId: string,
        payload?: UpdateSupplySourceRequest,
        options?: RawAxiosRequestConfig,
    ): Promise<
        (axios?: AxiosInstance, basePath?: string) => AxiosPromise<ErrorList>,
    >

    Update the configuration and capabilities of a supply source.

    Parameters

    • supplySourceId: string

      The unique identitier of a supply source.

    • Optionalpayload: UpdateSupplySourceRequest
    • Optionaloptions: RawAxiosRequestConfig

      Override http request option.

    Returns Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<ErrorList>>

    Throws

• updateSupplySourceStatus: function

  • updateSupplySourceStatus(
        supplySourceId: string,
        payload?: UpdateSupplySourceStatusRequest,
        options?: RawAxiosRequestConfig,
    ): Promise<
        (axios?: AxiosInstance, basePath?: string) => AxiosPromise<ErrorList>,
    >

    Update the status of a supply source.

    Parameters

    • supplySourceId: string

      The unique identifier of a supply source.

    • Optionalpayload: UpdateSupplySourceStatusRequest
    • Optionaloptions: RawAxiosRequestConfig

      Override http request option.

    Returns Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<ErrorList>>

    Throws