Function AppsApiAxiosParamCreator

AppsApi - axios parameter creator export

  • AppsApiAxiosParamCreator(configuration?): {
        apiAppsDelete: ((id?: string, options??: RawAxiosRequestConfig) => Promise<RequestArgs>);
        apiAppsGet: ((options??: RawAxiosRequestConfig) => Promise<RequestArgs>);
        apiAppsIdPut: ((id: string, description?: string, name?: string, userId?: string, options??: RawAxiosRequestConfig) => Promise<RequestArgs>);
        apiAppsPost: ((description?: string, name?: string, userId?: string, options??: RawAxiosRequestConfig) => Promise<RequestArgs>);
    }

  • Parameters

    Returns {
        apiAppsDelete: ((id?: string, options??: RawAxiosRequestConfig) => Promise<RequestArgs>);
        apiAppsGet: ((options??: RawAxiosRequestConfig) => Promise<RequestArgs>);
        apiAppsIdPut: ((id: string, description?: string, name?: string, userId?: string, options??: RawAxiosRequestConfig) => Promise<RequestArgs>);
        apiAppsPost: ((description?: string, name?: string, userId?: string, options??: RawAxiosRequestConfig) => Promise<RequestArgs>);
    }

    • apiAppsDelete: ((id?: string, options??: RawAxiosRequestConfig) => Promise<RequestArgs>)

      summary Delete an application

      Throws

        • (id?, options?): Promise<RequestArgs>

        • Parameters

          • Optionalid: string

            The id for the application to delete.

          • Optionaloptions: RawAxiosRequestConfig = {}

            Override http request option.

          Returns Promise<RequestArgs>

    • apiAppsGet: ((options??: RawAxiosRequestConfig) => Promise<RequestArgs>)

      summary Retrieve the info for applications you've created

      Throws

        • (options?): Promise<RequestArgs>

        • Parameters

          • Optionaloptions: RawAxiosRequestConfig = {}

            Override http request option.

          Returns Promise<RequestArgs>

    • apiAppsIdPut: ((id: string, description?: string, name?: string, userId?: string, options??: RawAxiosRequestConfig) => Promise<RequestArgs>)

      summary Create an application that can call the Mozaic API.

      Throws

        • (id, description?, name?, userId?, options?): Promise<RequestArgs>

        • Parameters

          • id: string

            The id of the record you wish to retrieve

          • Optionaldescription: string
          • Optionalname: string
          • OptionaluserId: string

            The user id to operate on their behalf (tenants only)

          • Optionaloptions: RawAxiosRequestConfig = {}

            Override http request option.

          Returns Promise<RequestArgs>

    • apiAppsPost: ((description?: string, name?: string, userId?: string, options??: RawAxiosRequestConfig) => Promise<RequestArgs>)

      summary Create an application that can call the Mozaic API.

      Throws

        • (description?, name?, userId?, options?): Promise<RequestArgs>

        • Parameters

          • Optionaldescription: string

            A description for the application. Max 140 characters.

          • Optionalname: string

            A name for the application

          • OptionaluserId: string

            The user id to operate on their behalf (tenants only)

          • Optionaloptions: RawAxiosRequestConfig = {}

            Override http request option.

          Returns Promise<RequestArgs>

Settings

Member Visibility