Function NotificationsApiAxiosParamCreator

NotificationsApi - axios parameter creator export

  • NotificationsApiAxiosParamCreator(configuration?): {
        apiNotificationsBulkPut: ((notificationsBulkUpdateDeets?: NotificationsBulkUpdateDeets, options??: RawAxiosRequestConfig) => Promise<RequestArgs>);
        apiNotificationsCountGet: ((markAsRead?: boolean, limit?: number, page?: number, userId?: string, options??: RawAxiosRequestConfig) => Promise<RequestArgs>);
        apiNotificationsGet: ((markAsRead?: boolean, limit?: number, page?: number, userId?: string, options??: RawAxiosRequestConfig) => Promise<RequestArgs>);
        apiNotificationsIdDelete: ((id: string, options??: RawAxiosRequestConfig) => Promise<RequestArgs>);
        apiNotificationsIdPut: ((id: string, notificationsUpdateDeets?: NotificationsUpdateDeets, options??: RawAxiosRequestConfig) => Promise<RequestArgs>);
        apiNotificationsNotificationNegotiatePost: ((options??: RawAxiosRequestConfig) => Promise<RequestArgs>);
    }

  • Parameters

    Returns {
        apiNotificationsBulkPut: ((notificationsBulkUpdateDeets?: NotificationsBulkUpdateDeets, options??: RawAxiosRequestConfig) => Promise<RequestArgs>);
        apiNotificationsCountGet: ((markAsRead?: boolean, limit?: number, page?: number, userId?: string, options??: RawAxiosRequestConfig) => Promise<RequestArgs>);
        apiNotificationsGet: ((markAsRead?: boolean, limit?: number, page?: number, userId?: string, options??: RawAxiosRequestConfig) => Promise<RequestArgs>);
        apiNotificationsIdDelete: ((id: string, options??: RawAxiosRequestConfig) => Promise<RequestArgs>);
        apiNotificationsIdPut: ((id: string, notificationsUpdateDeets?: NotificationsUpdateDeets, options??: RawAxiosRequestConfig) => Promise<RequestArgs>);
        apiNotificationsNotificationNegotiatePost: ((options??: RawAxiosRequestConfig) => Promise<RequestArgs>);
    }

    • apiNotificationsBulkPut: ((notificationsBulkUpdateDeets?: NotificationsBulkUpdateDeets, options??: RawAxiosRequestConfig) => Promise<RequestArgs>)

      summary Update one or many Notifications (mark as read)

      Throws

    • apiNotificationsCountGet: ((markAsRead?: boolean, limit?: number, page?: number, userId?: string, options??: RawAxiosRequestConfig) => Promise<RequestArgs>)

      summary Retrieve notifications counts

      Throws

        • (markAsRead?, limit?, page?, userId?, options?): Promise<RequestArgs>

        • Parameters

          • OptionalmarkAsRead: boolean
          • Optionallimit: number

            A limit of the number of objects to be returned for the next page, between 1 and 100. The default is 25

          • Optionalpage: number

            1-based page index for paginated results

          • OptionaluserId: string

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

          • Optionaloptions: RawAxiosRequestConfig = {}

            Override http request option.

          Returns Promise<RequestArgs>

    • apiNotificationsGet: ((markAsRead?: boolean, limit?: number, page?: number, userId?: string, options??: RawAxiosRequestConfig) => Promise<RequestArgs>)

      Notifications are brief dated messages. A Notification may be marked read or deleted

      summary Retrieve a list of Notifications

      Throws

        • (markAsRead?, limit?, page?, userId?, options?): Promise<RequestArgs>

        • Parameters

          • OptionalmarkAsRead: boolean
          • Optionallimit: number

            A limit of the number of objects to be returned for the next page, between 1 and 100. The default is 25

          • Optionalpage: number

            1-based page index for paginated results

          • OptionaluserId: string

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

          • Optionaloptions: RawAxiosRequestConfig = {}

            Override http request option.

          Returns Promise<RequestArgs>

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

      summary Deletes a Notification

      Throws

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

        • Parameters

          • id: string
          • Optionaloptions: RawAxiosRequestConfig = {}

            Override http request option.

          Returns Promise<RequestArgs>

    • apiNotificationsIdPut: ((id: string, notificationsUpdateDeets?: NotificationsUpdateDeets, options??: RawAxiosRequestConfig) => Promise<RequestArgs>)

      summary Update a Notification (mark as read)

      Throws

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

        • Parameters

          • id: string
          • OptionalnotificationsUpdateDeets: NotificationsUpdateDeets
          • Optionaloptions: RawAxiosRequestConfig = {}

            Override http request option.

          Returns Promise<RequestArgs>

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

      Throws

        • (options?): Promise<RequestArgs>

        • Parameters

          • Optionaloptions: RawAxiosRequestConfig = {}

            Override http request option.

          Returns Promise<RequestArgs>

Settings

Member Visibility